Package org.jfree.chart.plot

Class CompassPlot

java.lang.Object
org.jfree.chart.plot.Plot
org.jfree.chart.plot.CompassPlot
All Implemented Interfaces:
Serializable, Cloneable, EventListener, AxisChangeListener, DatasetChangeListener
public class CompassPlot
extends Plot
implements Cloneable, 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 Details

    • DEFAULT_LABEL_FONT

      public static final 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 Details

    • CompassPlot

      public CompassPlot()
      Default constructor.

    • CompassPlot

      public CompassPlot​(ValueDataset dataset)
      Constructs a new compass plot.
      Parameters:
      dataset - the dataset for the plot.

  • Method Details

    • 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 Font getLabelFont()
      Returns the label font.
      Returns:
      the label font.

    • setLabelFont

      public void setLabelFont​(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, Paint paint)
      Sets the series paint.
      Parameters:
      series - the series index.
      paint - the paint.

    • setSeriesOutlinePaint

      public void setSeriesOutlinePaint​(int series, Paint p)
      Sets the series outline paint.
      Parameters:
      series - the series index.
      p - the paint.

    • setSeriesOutlineStroke

      public void setSeriesOutlineStroke​(int series, 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​(Graphics2D g2, Rectangle2D plotArea, PlotState parentState, PlotRenderingInfo 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.
      parentState - the state from the parent plot, if there is one.
      info - collects info about the drawing.

    • getPlotType

      public String getPlotType()
      Returns a short string describing the type of plot.
      Specified by:
      getPlotType in class Plot
      Returns:
      a string describing the plot.

    • 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.

    • getLegendItemLabels

      public List getLegendItemLabels()
      Deprecated.
      use getLegendItems().
      Returns a list of legend item labels.
      Returns:
      a list of legend item labels.

    • equals

      public boolean equals​(Object object)
      Tests an object for equality with this plot.
      Overrides:
      equals in class Plot
      Parameters:
      object - the object.
      Returns:
      A boolean.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the annotation.
      Overrides:
      clone in class Plot
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - this class will not throw this exception, but subclasses (if any) might.

    • setRevolutionDistance

      public void setRevolutionDistance​(double size)
      Sets the count to complete one revolution. Can be arbitaly set For degrees (the default) it is 360, for radians this is 2*Pi, etc
      Parameters:
      size - the count to complete one revolution.

    • getRevolutionDistance

      public double getRevolutionDistance()
      Gets the count to complete one revolution.
      Returns:
      the count to complete one revolution