- java.lang.Object
-
- org.jfree.chart.plot.Plot
-
- org.jfree.chart.plot.compass.CompassPlot
-
- All Implemented Interfaces:
Serializable,Cloneable,EventListener,PublicCloneable,ChartElement,AnnotationChangeListener,AxisChangeListener,MarkerChangeListener,org.jfree.chart.legend.LegendItemSource,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 aValueDataset.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static FontDEFAULT_LABEL_FONTThe default label font.protected static ResourceBundlelocalizationResourcesThe resourceBundle for the localization.static intNO_LABELSA constant for the label type.protected doublerevolutionDistanceThe count to complete one revolution.static intVALUE_LABELSA 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_LEGEND_ITEM_BOX, DEFAULT_LEGEND_ITEM_CIRCLE, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO
-
-
Constructor Summary
Constructors Constructor Description CompassPlot()Default constructor.CompassPlot(ValueDataset dataset)Constructs a new compass plot.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDataset(ValueDataset dataset)Adds a dataset to the compass.voidaddDataset(ValueDataset dataset, MeterNeedle needle)Adds a dataset to the compass.Objectclone()Returns a clone of the plot.voiddraw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)Draws the plot on a Java 2D graphics device (such as the screen or a printer).booleanequals(Object obj)Tests an object for equality with this plot.protected FontgetCompassFont(int radius)Returns the font for the compass, adjusted for the size of the plot.ValueDataset[]getDatasets()Returns an array of dataset references for the plot.booleangetDrawBorder()Returns a flag that controls whether or not a border is drawn.FontgetLabelFont()Returns the label font.intgetLabelType()Returns the label type.org.jfree.chart.legend.LegendItemCollectiongetLegendItems()Returns the legend items for the plot.StringgetPlotType()Returns a short string describing the type of plot.doublegetRevolutionDistance()Gets the count to complete one revolution.PaintgetRoseCenterPaint()Returns the paint used to fill the inner background area of the compass.PaintgetRoseHighlightPaint()Returns the paint used to draw the circles, symbols and labels on the compass.PaintgetRosePaint()Returns the paint used to fill the outer circle of the compass.voidreceive(ChartElementVisitor visitor)Receives a chart element visitor.voidsetDrawBorder(boolean status)Sets a flag that controls whether or not a border is drawn.voidsetLabelFont(Font font)Sets the label font and sends aPlotChangeEventto all registered listeners.voidsetLabelType(int type)Sets the label type (eitherNO_LABELSorVALUE_LABELS.voidsetRevolutionDistance(double size)Sets the count to complete one revolution.voidsetRoseCenterPaint(Paint paint)Sets the paint used to fill the inner background area of the compass, and sends aPlotChangeEventto all registered listeners.voidsetRoseHighlightPaint(Paint paint)Sets the paint used to draw the circles, symbols and labels of the compass, and sends aPlotChangeEventto all registered listeners.voidsetRosePaint(Paint paint)Sets the paint used to fill the outer circle of the compass, and sends aPlotChangeEventto all registered listeners.voidsetSeriesNeedle(int type)Sets the needle type.voidsetSeriesNeedle(int index, int type)Sets the needle for a series.voidsetSeriesNeedle(int index, MeterNeedle needle)Sets the needle for a series and sends aPlotChangeEventto all registered listeners.voidsetSeriesOutlinePaint(int series, Paint p)Sets the series outline paint.voidsetSeriesOutlineStroke(int series, Stroke stroke)Sets the series outline stroke.voidsetSeriesPaint(int series, Paint paint)Sets the series paint.voidzoom(double percent)No zooming is implemented for compass plot, so this method is empty.-
Methods inherited from class org.jfree.chart.plot.Plot
addChangeListener, annotationChanged, axisChanged, createAndAddEntity, datasetChanged, drawBackground, drawBackgroundImage, drawNoDataMessage, drawOutline, fetchElementHintingFlag, fillBackground, fillBackground, fireChangeEvent, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getChart, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, handleClick, isNotify, isOutlineVisible, isSubplot, markerChanged, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setChart, setDrawingSupplier, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setNotify, setOutlinePaint, setOutlineStroke, setOutlineVisible, setParent
-
-
-
-
Field Detail
-
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
-
localizationResources
protected static ResourceBundle localizationResources
The resourceBundle for the localization.
-
revolutionDistance
protected double revolutionDistance
The count to complete one revolution. Can be arbitrarily set For degrees (the default) it is 360, for radians this is 2*Pi, etc
-
-
Constructor Detail
-
CompassPlot
public CompassPlot()
Default constructor.
-
CompassPlot
public CompassPlot(ValueDataset dataset)
Constructs a new compass plot.- Parameters:
dataset- the dataset for the plot (nullpermitted).
-
-
Method Detail
-
getLabelType
public int getLabelType()
Returns the label type. Defined by the constants:NO_LABELSandVALUE_LABELS.- Returns:
- The label type.
- See Also:
setLabelType(int)
-
setLabelType
public void setLabelType(int type)
Sets the label type (eitherNO_LABELSorVALUE_LABELS.- Parameters:
type- the type.- See Also:
getLabelType()
-
getLabelFont
public Font getLabelFont()
Returns the label font.- Returns:
- The label font.
- See Also:
setLabelFont(Font)
-
setLabelFont
public void setLabelFont(Font font)
Sets the label font and sends aPlotChangeEventto all registered listeners.- Parameters:
font- the new label font.- See Also:
getLabelFont()
-
getRosePaint
public Paint getRosePaint()
Returns the paint used to fill the outer circle of the compass.- Returns:
- The paint (never
null). - See Also:
setRosePaint(Paint)
-
setRosePaint
public void setRosePaint(Paint paint)
Sets the paint used to fill the outer circle of the compass, and sends aPlotChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getRosePaint()
-
getRoseCenterPaint
public Paint getRoseCenterPaint()
Returns the paint used to fill the inner background area of the compass.- Returns:
- The paint (never
null). - See Also:
setRoseCenterPaint(Paint)
-
setRoseCenterPaint
public void setRoseCenterPaint(Paint paint)
Sets the paint used to fill the inner background area of the compass, and sends aPlotChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getRoseCenterPaint()
-
getRoseHighlightPaint
public Paint getRoseHighlightPaint()
Returns the paint used to draw the circles, symbols and labels on the compass.- Returns:
- The paint (never
null). - See Also:
setRoseHighlightPaint(Paint)
-
setRoseHighlightPaint
public void setRoseHighlightPaint(Paint paint)
Sets the paint used to draw the circles, symbols and labels of the compass, and sends aPlotChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getRoseHighlightPaint()
-
getDrawBorder
public boolean getDrawBorder()
Returns a flag that controls whether or not a border is drawn.- Returns:
- The flag.
- See Also:
setDrawBorder(boolean)
-
setDrawBorder
public void setDrawBorder(boolean status)
Sets a flag that controls whether or not a border is drawn.- Parameters:
status- the flag status.- See Also:
getDrawBorder()
-
setSeriesPaint
public void setSeriesPaint(int series, Paint paint)
Sets the series paint.- Parameters:
series- the series index.paint- the paint.- See Also:
setSeriesOutlinePaint(int, Paint)
-
setSeriesOutlinePaint
public void setSeriesOutlinePaint(int series, Paint p)
Sets the series outline paint.- Parameters:
series- the series index.p- the paint.- See Also:
setSeriesPaint(int, Paint)
-
setSeriesOutlineStroke
public void setSeriesOutlineStroke(int series, Stroke stroke)
Sets the series outline stroke.- Parameters:
series- the series index.stroke- the stroke.- See Also:
setSeriesOutlinePaint(int, Paint)
-
setSeriesNeedle
public void setSeriesNeedle(int type)
Sets the needle type.- Parameters:
type- the type.- See Also:
setSeriesNeedle(int, int)
-
setSeriesNeedle
public void setSeriesNeedle(int index, int type)
Sets the needle for a series. The needle type is one of the following:- 0 =
ArrowNeedle; - 1 =
LineNeedle; - 2 =
LongNeedle; - 3 =
PinNeedle; - 4 =
PlumNeedle; - 5 =
PointerNeedle; - 6 =
ShipNeedle; - 7 =
WindNeedle; - 8 =
ArrowNeedle; - 9 =
MiddlePinNeedle;
- Parameters:
index- the series index.type- the needle type.- See Also:
setSeriesNeedle(int)
- 0 =
-
setSeriesNeedle
public void setSeriesNeedle(int index, MeterNeedle needle)
Sets the needle for a series and sends aPlotChangeEventto all registered listeners.- Parameters:
index- the series index.needle- the needle.
-
getDatasets
public ValueDataset[] getDatasets()
Returns an array of dataset references for the plot.- Returns:
- The dataset for the plot, cast as a ValueDataset.
- See Also:
addDataset(ValueDataset)
-
addDataset
public void addDataset(ValueDataset dataset)
Adds a dataset to the compass.- Parameters:
dataset- the new dataset (nullignored).- See Also:
addDataset(ValueDataset, MeterNeedle)
-
addDataset
public void addDataset(ValueDataset dataset, MeterNeedle needle)
Adds a dataset to the compass.- Parameters:
dataset- the new dataset (nullignored).needle- the needle (nullpermitted).
-
receive
public void receive(ChartElementVisitor visitor)
Receives a chart element visitor. Many plot subclasses will override this method to handle their subcomponents.- Specified by:
receivein interfaceChartElement- Overrides:
receivein classPlot- Parameters:
visitor- the visitor (nullnot permitted).
-
draw
public void draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).
-
getPlotType
public String getPlotType()
Returns a short string describing the type of plot.- Specified by:
getPlotTypein classPlot- Returns:
- A string describing the plot.
-
getLegendItems
public org.jfree.chart.legend.LegendItemCollection getLegendItems()
Returns the legend items for the plot. For now, no legend is available - this method returns null.- Specified by:
getLegendItemsin interfaceorg.jfree.chart.legend.LegendItemSource- Overrides:
getLegendItemsin classPlot- Returns:
- The legend items.
-
zoom
public void zoom(double percent)
No zooming is implemented for compass plot, so this method is empty.
-
getCompassFont
protected Font getCompassFont(int radius)
Returns the font for the compass, adjusted for the size of the plot.- Parameters:
radius- the radius.- Returns:
- The font.
-
clone
public Object clone() throws CloneNotSupportedException
Returns a clone of the plot.- Specified by:
clonein interfacePublicCloneable- Overrides:
clonein classPlot- 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 arbitrarily set For degrees (the default) it is 360, for radians this is 2*Pi, etc- Parameters:
size- the count to complete one revolution.- See Also:
getRevolutionDistance()
-
getRevolutionDistance
public double getRevolutionDistance()
Gets the count to complete one revolution.- Returns:
- The count to complete one revolution.
- See Also:
setRevolutionDistance(double)
-
-