public class

DialPlot

extends Plot
implements DialLayerChangeListener
java.lang.Object
   ↳ org.jfree.chart.plot.Plot
     ↳ org.jfree.chart.plot.dial.DialPlot

Class Overview

A dial plot composed of user-definable layers. The example shown here is generated by the DialDemo2.java program included in the JFreeChart Demo Collection:

DialPlotSample.png

Summary

[Expand]
Inherited Constants
From class org.jfree.chart.plot.Plot
[Expand]
Inherited Fields
From class org.jfree.chart.plot.Plot
Public Constructors
DialPlot()
Creates a new instance of DialPlot.
DialPlot(ValueDataset dataset)
Creates a new instance of DialPlot.
Public Methods
void addLayer(DialLayer layer)
Adds a layer to the plot and sends a PlotChangeEvent to all registered listeners.
void addPointer(DialPointer pointer)
Adds a pointer to the plot and sends a PlotChangeEvent to all registered listeners.
void addScale(int index, DialScale scale)
Adds a dial scale to the plot and sends a PlotChangeEvent to all registered listeners.
void dialLayerChanged(DialLayerChangeEvent event)
Receives notification when a layer has changed, and responds by forwarding a PlotChangeEvent to all registered listeners.
void draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
Draws the plot.
boolean equals(Object obj)
Tests this DialPlot instance for equality with an arbitrary object.
DialLayer getBackground()
Returns the background.
DialLayer getCap()
Returns the cap.
ValueDataset getDataset(int index)
Returns the dataset at the given index.
ValueDataset getDataset()
Returns the primary dataset for the plot.
int getDatasetCount()
Returns the number of datasets.
DialFrame getDialFrame()
Returns the dial's frame.
int getLayerIndex(DialLayer layer)
Returns the index for the specified layer.
String getPlotType()
Returns the plot type.
DialPointer getPointerForDataset(int datasetIndex)
Returns the dial pointer that is associated with the specified dataset, or null.
int getPointerIndex(DialPointer pointer)
Returns the index for the specified pointer.
DialScale getScale(int index)
Returns the scale at the given index.
DialScale getScaleForDataset(int datasetIndex)
Returns the dial scale for a specific dataset.
double getValue(int datasetIndex)
Returns the value from the specified dataset.
double getViewHeight()
Returns the height of the viewing rectangle.
double getViewWidth()
Returns the width of the viewing rectangle.
double getViewX()
Returns the x-coordinate of the viewing rectangle.
double getViewY()
Returns the y-coordinate of the viewing rectangle.
int hashCode()
Returns a hash code for this instance.
void mapDatasetToScale(int index, int scaleIndex)
Maps a dataset to a particular scale.
static Rectangle2D rectangleByRadius(Rectangle2D rect, double radiusW, double radiusH)
A utility method that computes a rectangle using relative radius values.
void removeLayer(DialLayer layer)
Removes the specified layer and sends a PlotChangeEvent to all registered listeners.
void removeLayer(int index)
Removes the layer at the specified index and sends a PlotChangeEvent to all registered listeners.
void removePointer(DialPointer pointer)
Removes the specified pointer and sends a PlotChangeEvent to all registered listeners.
void removePointer(int index)
Removes the pointer at the specified index and sends a PlotChangeEvent to all registered listeners.
void setBackground(DialLayer background)
Sets the background layer and sends a PlotChangeEvent to all registered listeners.
void setCap(DialLayer cap)
Sets the cap and sends a PlotChangeEvent to all registered listeners.
void setDataset(ValueDataset dataset)
Sets the dataset for the plot, replacing the existing dataset, if there is one, and sends a PlotChangeEvent to all registered listeners.
void setDataset(int index, ValueDataset dataset)
Sets a dataset for the plot.
void setDialFrame(DialFrame frame)
Sets the dial's frame and sends a PlotChangeEvent to all registered listeners.
void setView(double x, double y, double w, double h)
Sets the viewing rectangle, relative to the dial's framing rectangle, and sends a PlotChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.chart.plot.Plot
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.event.AxisChangeListener
From interface org.jfree.chart.event.MarkerChangeListener
From interface org.jfree.chart.plot.dial.DialLayerChangeListener
From interface org.jfree.data.general.DatasetChangeListener

Public Constructors

public DialPlot ()

Creates a new instance of DialPlot.

public DialPlot (ValueDataset dataset)

Creates a new instance of DialPlot.

Parameters
dataset the dataset (null permitted).

Public Methods

public void addLayer (DialLayer layer)

Adds a layer to the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
layer the layer (null not permitted).

public void addPointer (DialPointer pointer)

Adds a pointer to the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
pointer the pointer (null not permitted).

public void addScale (int index, DialScale scale)

Adds a dial scale to the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
index the scale index.
scale the scale (null not permitted).

public void dialLayerChanged (DialLayerChangeEvent event)

Receives notification when a layer has changed, and responds by forwarding a PlotChangeEvent to all registered listeners.

Parameters
event the event.

public void draw (Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)

Draws the plot. This method is usually called by the JFreeChart instance that manages the plot.

Parameters
g2 the graphics target.
area the area in which the plot should be drawn.
anchor the anchor point (typically the last point that the mouse clicked on, null is permitted).
parentState the state for the parent plot (if any).
info used to collect plot rendering info (null permitted).

public boolean equals (Object obj)

Tests this DialPlot instance for equality with an arbitrary object. The plot's dataset(s) is (are) not included in the test.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public DialLayer getBackground ()

Returns the background.

Returns
  • The background (possibly null).
See Also

public DialLayer getCap ()

Returns the cap.

Returns
  • The cap (possibly null).
See Also

public ValueDataset getDataset (int index)

Returns the dataset at the given index.

Parameters
index the dataset index.
Returns
  • The dataset (possibly null).

public ValueDataset getDataset ()

Returns the primary dataset for the plot.

Returns
  • The primary dataset (possibly null).

public int getDatasetCount ()

Returns the number of datasets.

Returns
  • The number of datasets.

public DialFrame getDialFrame ()

Returns the dial's frame.

Returns
  • The dial's frame (never null).
See Also

public int getLayerIndex (DialLayer layer)

Returns the index for the specified layer.

Parameters
layer the layer (null not permitted).
Returns
  • The layer index.

public String getPlotType ()

Returns the plot type.

Returns
  • "DialPlot"

public DialPointer getPointerForDataset (int datasetIndex)

Returns the dial pointer that is associated with the specified dataset, or null.

Parameters
datasetIndex the dataset index.
Returns
  • The pointer.

public int getPointerIndex (DialPointer pointer)

Returns the index for the specified pointer.

Parameters
pointer the pointer (null not permitted).
Returns
  • The pointer index.

public DialScale getScale (int index)

Returns the scale at the given index.

Parameters
index the scale index.
Returns
  • The scale (possibly null).

public DialScale getScaleForDataset (int datasetIndex)

Returns the dial scale for a specific dataset.

Parameters
datasetIndex the dataset index.
Returns
  • The dial scale.

public double getValue (int datasetIndex)

Returns the value from the specified dataset.

Parameters
datasetIndex the dataset index.
Returns
  • The data value.

public double getViewHeight ()

Returns the height of the viewing rectangle. This is specified in the range 0.0 to 1.0, relative to the dial's framing rectangle.

Returns
  • The height of the viewing rectangle.
See Also

public double getViewWidth ()

Returns the width of the viewing rectangle. This is specified in the range 0.0 to 1.0, relative to the dial's framing rectangle.

Returns
  • The width of the viewing rectangle.
See Also

public double getViewX ()

Returns the x-coordinate of the viewing rectangle. This is specified in the range 0.0 to 1.0, relative to the dial's framing rectangle.

Returns
  • The x-coordinate of the viewing rectangle.
See Also

public double getViewY ()

Returns the y-coordinate of the viewing rectangle. This is specified in the range 0.0 to 1.0, relative to the dial's framing rectangle.

Returns
  • The y-coordinate of the viewing rectangle.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • The hash code.

public void mapDatasetToScale (int index, int scaleIndex)

Maps a dataset to a particular scale.

Parameters
index the dataset index (zero-based).
scaleIndex the scale index (zero-based).

public static Rectangle2D rectangleByRadius (Rectangle2D rect, double radiusW, double radiusH)

A utility method that computes a rectangle using relative radius values.

Parameters
rect the reference rectangle (null not permitted).
radiusW the width radius (must be > 0.0)
radiusH the height radius.
Returns
  • A new rectangle.

public void removeLayer (DialLayer layer)

Removes the specified layer and sends a PlotChangeEvent to all registered listeners.

Parameters
layer the layer (null not permitted).

public void removeLayer (int index)

Removes the layer at the specified index and sends a PlotChangeEvent to all registered listeners.

Parameters
index the index.

public void removePointer (DialPointer pointer)

Removes the specified pointer and sends a PlotChangeEvent to all registered listeners.

Parameters
pointer the pointer (null not permitted).

public void removePointer (int index)

Removes the pointer at the specified index and sends a PlotChangeEvent to all registered listeners.

Parameters
index the index.

public void setBackground (DialLayer background)

Sets the background layer and sends a PlotChangeEvent to all registered listeners.

Parameters
background the background layer (null permitted).
See Also

public void setCap (DialLayer cap)

Sets the cap and sends a PlotChangeEvent to all registered listeners.

Parameters
cap the cap (null permitted).
See Also

public void setDataset (ValueDataset dataset)

Sets the dataset for the plot, replacing the existing dataset, if there is one, and sends a PlotChangeEvent to all registered listeners.

Parameters
dataset the dataset (null permitted).

public void setDataset (int index, ValueDataset dataset)

Sets a dataset for the plot.

Parameters
index the dataset index.
dataset the dataset (null permitted).

public void setDialFrame (DialFrame frame)

Sets the dial's frame and sends a PlotChangeEvent to all registered listeners.

Parameters
frame the frame (null not permitted).
See Also

public void setView (double x, double y, double w, double h)

Sets the viewing rectangle, relative to the dial's framing rectangle, and sends a PlotChangeEvent to all registered listeners.

Parameters
x the x-coordinate (in the range 0.0 to 1.0).
y the y-coordinate (in the range 0.0 to 1.0).
w the width (in the range 0.0 to 1.0).
h the height (in the range 0.0 to 1.0).
See Also