Class CategoryPlot
- java.lang.Object
-
- org.jfree.chart.plot.Plot
-
- org.jfree.chart.plot.CategoryPlot
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,AnnotationChangeListener
,AxisChangeListener
,MarkerChangeListener
,RendererChangeListener
,LegendItemSource
,Pannable
,ValueAxisPlot
,Zoomable
,PublicCloneable
,DatasetChangeListener
- Direct Known Subclasses:
CombinedDomainCategoryPlot
,CombinedRangeCategoryPlot
public class CategoryPlot extends Plot implements ValueAxisPlot, Pannable, Zoomable, AnnotationChangeListener, RendererChangeListener, java.lang.Cloneable, PublicCloneable, java.io.Serializable
A general plotting class that uses data from aCategoryDataset
and renders each data item using aCategoryItemRenderer
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private double
anchorValue
The anchor value.private java.util.List<CategoryAnnotation>
annotations
A (possibly empty) list of annotations for the plot.private RectangleInsets
axisOffset
The offset between the data area and the axes.private java.util.Map<java.lang.Integer,java.util.Collection<CategoryMarker>>
backgroundDomainMarkers
A map containing lists of markers for the domain axes.private java.util.Map<java.lang.Integer,java.util.Collection<Marker>>
backgroundRangeMarkers
A map containing lists of markers for the range axes.private SortOrder
columnRenderingOrder
Controls the order in which the columns are traversed when rendering the data items.private int
crosshairDatasetIndex
The index for the dataset that the crosshairs are linked to (this determines which axes the crosshairs are plotted against).private java.util.Map<java.lang.Integer,CategoryDataset>
datasets
Storage for the datasets.private java.util.TreeMap<java.lang.Integer,java.util.List<java.lang.Integer>>
datasetToDomainAxesMap
Storage for keys that map each dataset to one or more domain axes.private java.util.TreeMap<java.lang.Integer,java.util.List<java.lang.Integer>>
datasetToRangeAxesMap
Storage for keys that map each dataset to one or more range axes.static java.awt.Paint
DEFAULT_CROSSHAIR_PAINT
The default crosshair paint.static java.awt.Stroke
DEFAULT_CROSSHAIR_STROKE
The default crosshair stroke.static boolean
DEFAULT_CROSSHAIR_VISIBLE
The default crosshair visibility.static boolean
DEFAULT_DOMAIN_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the domain axis.static java.awt.Paint
DEFAULT_GRIDLINE_PAINT
The default grid line paint.static java.awt.Stroke
DEFAULT_GRIDLINE_STROKE
The default grid line stroke.static boolean
DEFAULT_RANGE_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the range axis.static java.awt.Font
DEFAULT_VALUE_LABEL_FONT
The default value label font.private java.util.Map<java.lang.Integer,CategoryAxis>
domainAxes
Storage for the domain axes.private java.util.Map<java.lang.Integer,AxisLocation>
domainAxisLocations
Storage for the domain axis locations.private java.lang.Comparable
domainCrosshairColumnKey
The column key for the crosshair point.private java.awt.Paint
domainCrosshairPaint
The paint used to draw the domain crosshair if it is visible.private java.lang.Comparable
domainCrosshairRowKey
The row key for the crosshair point.private java.awt.Stroke
domainCrosshairStroke
The stroke used to draw the domain crosshair if it is visible.private boolean
domainCrosshairVisible
A flag that controls the visibility of the domain crosshair.private java.awt.Paint
domainGridlinePaint
The paint used to draw the domain grid-lines.private CategoryAnchor
domainGridlinePosition
The position of the domain gridlines relative to the category.private java.awt.Stroke
domainGridlineStroke
The stroke used to draw the domain grid-lines.private boolean
domainGridlinesVisible
A flag that controls whether the grid-lines for the domain axis are visible.private boolean
drawSharedDomainAxis
A flag that controls whether or not the shared domain axis is drawn (only relevant when the plot is being used as a subplot).private AxisSpace
fixedDomainAxisSpace
The fixed space for the domain axis.private LegendItemCollection
fixedLegendItems
An optional collection of legend items that can be returned by the getLegendItems() method.private AxisSpace
fixedRangeAxisSpace
The fixed space for the range axis.private java.util.Map<java.lang.Integer,java.util.Collection<CategoryMarker>>
foregroundDomainMarkers
A map containing lists of markers for the domain axes.private java.util.Map<java.lang.Integer,java.util.Collection<Marker>>
foregroundRangeMarkers
A map containing lists of markers for the range axes.protected static java.util.ResourceBundle
localizationResources
The resourceBundle for the localization.private PlotOrientation
orientation
The plot orientation.private java.util.Map<java.lang.Integer,ValueAxis>
rangeAxes
Storage for the range axes.private java.util.Map<java.lang.Integer,AxisLocation>
rangeAxisLocations
Storage for the range axis locations.private boolean
rangeCrosshairLockedOnData
A flag that controls whether or not the crosshair locks onto actual data points.private java.awt.Paint
rangeCrosshairPaint
The color used to draw the crosshair (if any).private java.awt.Stroke
rangeCrosshairStroke
The pen/brush used to draw the crosshair (if any).private double
rangeCrosshairValue
The range crosshair value.private boolean
rangeCrosshairVisible
A flag that controls whether or not a range crosshair is drawn.private java.awt.Paint
rangeGridlinePaint
The paint used to draw the range axis grid-lines.private java.awt.Stroke
rangeGridlineStroke
The stroke used to draw the range axis grid-lines.private boolean
rangeGridlinesVisible
A flag that controls whether the grid-lines for the range axis are visible.private java.awt.Paint
rangeMinorGridlinePaint
The paint used to draw the range minor grid-lines.private java.awt.Stroke
rangeMinorGridlineStroke
The stroke used to draw the range minor grid-lines.private boolean
rangeMinorGridlinesVisible
A flag that controls whether or not gridlines are shown for the minor tick values on the primary range axis.private boolean
rangePannable
A flag that controls whether or not panning is enabled for the range axis/axes.private java.awt.Paint
rangeZeroBaselinePaint
The paint used for the zero baseline against the range axis.private java.awt.Stroke
rangeZeroBaselineStroke
The stroke used for the zero baseline against the range axis.private boolean
rangeZeroBaselineVisible
A flag that controls whether or not the zero baseline against the range axis is visible.private java.util.Map<java.lang.Integer,CategoryItemRenderer>
renderers
Storage for the renderers.private DatasetRenderingOrder
renderingOrder
The dataset rendering order.private SortOrder
rowRenderingOrder
Controls the order in which the rows are traversed when rendering the data items.private static long
serialVersionUID
For serialization.private ShadowGenerator
shadowGenerator
The shadow generator for the plot (null
permitted).private int
weight
The weight for the plot (only relevant when the plot is used as a subplot within a combined plot).-
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 CategoryPlot()
Default constructor.CategoryPlot(CategoryDataset dataset, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryItemRenderer renderer)
Creates a new plot.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAnnotation(CategoryAnnotation annotation)
Adds an annotation to the plot and sends aPlotChangeEvent
to all registered listeners.void
addAnnotation(CategoryAnnotation annotation, boolean notify)
Adds an annotation to the plot and, if requested, sends aPlotChangeEvent
to all registered listeners.void
addDomainMarker(int index, CategoryMarker marker, Layer layer)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.void
addDomainMarker(int index, CategoryMarker marker, Layer layer, boolean notify)
Adds a marker for display by a particular renderer and, if requested, sends aPlotChangeEvent
to all registered listeners.void
addDomainMarker(CategoryMarker marker)
Adds a marker for display (in the foreground) against the domain axis and sends aPlotChangeEvent
to all registered listeners.void
addDomainMarker(CategoryMarker marker, Layer layer)
Adds a marker for display against the domain axis and sends aPlotChangeEvent
to all registered listeners.void
addRangeMarker(int index, Marker marker, Layer layer)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.void
addRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.void
addRangeMarker(Marker marker)
Adds a marker for display (in the foreground) against the range axis and sends aPlotChangeEvent
to all registered listeners.void
addRangeMarker(Marker marker, Layer layer)
Adds a marker for display against the range axis and sends aPlotChangeEvent
to all registered listeners.void
annotationChanged(AnnotationChangeEvent event)
Receives notification of a change to anAnnotation
added to this plot.protected AxisSpace
calculateAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea)
Calculates the space required for the axes.protected AxisSpace
calculateDomainAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the domain axis/axes.protected AxisSpace
calculateRangeAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the range axis/axes.boolean
canEqual(java.lang.Object other)
Ensures symmetry between super/subclass implementations of equals.private void
checkAxisIndices(java.util.List<java.lang.Integer> indices)
This method is used to perform argument checking on the list of axis indices passed to mapDatasetToDomainAxes() and mapDatasetToRangeAxes().void
clearAnnotations()
Clears all the annotations and sends aPlotChangeEvent
to all registered listeners.void
clearDomainAxes()
Clears the domain axes from the plot and sends aPlotChangeEvent
to all registered listeners.void
clearDomainMarkers()
Clears all the domain markers for the plot and sends aPlotChangeEvent
to all registered listeners.void
clearDomainMarkers(int index)
Clears all the domain markers for the specified renderer.void
clearRangeAxes()
Clears the range axes from the plot and sends aPlotChangeEvent
to all registered listeners.void
clearRangeMarkers()
Clears all the range markers for the plot and sends aPlotChangeEvent
to all registered listeners.void
clearRangeMarkers(int index)
Clears all the range markers for the specified renderer.java.lang.Object
clone()
Returns a clone of the plot.private java.util.Map
cloneMarkerMap(java.util.Map map)
A utility method to clone the marker maps.void
configureDomainAxes()
Configures the domain axes.void
configureRangeAxes()
Configures the range axes.void
datasetChanged(DatasetChangeEvent event)
Receives notification of a change to the plot's dataset.private java.util.List<CategoryDataset>
datasetsMappedToDomainAxis(int axisIndex)
Returns a list of the datasets that are mapped to the axis with the specified index.private java.util.List<CategoryDataset>
datasetsMappedToRangeAxis(int axisIndex)
A utility method that returns a list of datasets that are mapped to a given range axis.void
draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area, java.awt.geom.Point2D anchor, PlotState parentState, PlotRenderingInfo state)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).protected void
drawAnnotations(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
Draws the annotations.protected java.util.Map
drawAxes(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, PlotRenderingInfo plotState)
A utility method for drawing the plot's axes.void
drawBackground(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
Draws the plot background (the background color and/or image).protected void
drawDomainCrosshair(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, PlotOrientation orientation, int datasetIndex, java.lang.Comparable rowKey, java.lang.Comparable columnKey, java.awt.Stroke stroke, java.awt.Paint paint)
Draws a domain crosshair.protected void
drawDomainGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
Draws the domain gridlines for the plot, if they are visible.protected void
drawDomainMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, Layer layer)
Draws the domain markers (if any) for an axis and layer.protected void
drawRangeCrosshair(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, java.awt.Stroke stroke, java.awt.Paint paint)
Draws a range crosshair.protected void
drawRangeGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, java.util.List ticks)
Draws the range gridlines for the plot, if they are visible.protected void
drawRangeLine(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, double value, java.awt.Stroke stroke, java.awt.Paint paint)
Utility method for drawing a line perpendicular to the range axis (used for crosshairs).protected void
drawRangeMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, Layer layer)
Draws the range markers (if any) for an axis and layer.protected void
drawZeroRangeBaseline(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
Draws a base line across the chart at value zero on the range axis.boolean
equals(java.lang.Object obj)
Tests the plot for equality with an arbitrary object.private int
findRangeAxisIndex(ValueAxis axis)
double
getAnchorValue()
Returns the anchor value.java.util.List
getAnnotations()
Returns the list of annotations.RectangleInsets
getAxisOffset()
Returns the axis offset.java.util.List
getCategories()
Returns a list of the categories in the plot's primary dataset.java.util.List
getCategoriesForAxis(CategoryAxis axis)
Returns a list of the categories that should be displayed for the specified axis.SortOrder
getColumnRenderingOrder()
Returns the order in which the columns are rendered.int
getCrosshairDatasetIndex()
Returns the dataset index for the crosshair.Range
getDataRange(ValueAxis axis)
Returns the range of data values that will be plotted against the range axis.CategoryDataset
getDataset()
Returns the primary dataset for the plot.CategoryDataset
getDataset(int index)
Returns the dataset with the given index, ornull
if there is no dataset.int
getDatasetCount()
Returns the number of datasets.private java.util.List<java.lang.Integer>
getDatasetIndices(DatasetRenderingOrder order)
Returns the indices of the non-null datasets in the specified order.DatasetRenderingOrder
getDatasetRenderingOrder()
Returns the dataset rendering order.java.util.Map<java.lang.Integer,CategoryDataset>
getDatasets()
Returns a map containing the datasets that are assigned to this plot.java.util.Map<java.lang.Integer,CategoryAxis>
getDomainAxes()
Returns a map containing the domain axes that are assigned to this plot.CategoryAxis
getDomainAxis()
Returns the domain axis for the plot.CategoryAxis
getDomainAxis(int index)
Returns a domain axis.int
getDomainAxisCount()
Returns the number of domain axes.RectangleEdge
getDomainAxisEdge()
Returns the domain axis edge.RectangleEdge
getDomainAxisEdge(int index)
Returns the edge for a domain axis.CategoryAxis
getDomainAxisForDataset(int index)
Returns the domain axis for a dataset.int
getDomainAxisIndex(CategoryAxis axis)
Returns the index of the specified axis, or-1
if the axis is not assigned to the plot.AxisLocation
getDomainAxisLocation()
Returns the domain axis location for the primary domain axis.AxisLocation
getDomainAxisLocation(int index)
Returns the location for a domain axis.java.lang.Comparable
getDomainCrosshairColumnKey()
Returns the column key for the domain crosshair.java.awt.Paint
getDomainCrosshairPaint()
Returns the paint used to draw the domain crosshair.java.lang.Comparable
getDomainCrosshairRowKey()
Returns the row key for the domain crosshair.java.awt.Stroke
getDomainCrosshairStroke()
Returns the stroke used to draw the domain crosshair.java.awt.Paint
getDomainGridlinePaint()
Returns the paint used to draw grid-lines against the domain axis.CategoryAnchor
getDomainGridlinePosition()
Returns the position used for the domain gridlines.java.awt.Stroke
getDomainGridlineStroke()
Returns the stroke used to draw grid-lines against the domain axis.java.util.Collection<CategoryMarker>
getDomainMarkers(int index, Layer layer)
Returns a collection of domain markers for a particular renderer and layer.java.util.Collection
getDomainMarkers(Layer layer)
Returns the list of domain markers (read only) for the specified layer.boolean
getDrawSharedDomainAxis()
Returns the flag that controls whether or not the shared domain axis is drawn for each subplot.AxisSpace
getFixedDomainAxisSpace()
Returns the fixed domain axis space.LegendItemCollection
getFixedLegendItems()
Returns the fixed legend items, if any.AxisSpace
getFixedRangeAxisSpace()
Returns the fixed range axis space.int
getIndexOf(CategoryItemRenderer renderer)
Returns the index of the specified renderer, or-1
if the renderer is not assigned to this plot.LegendItemCollection
getLegendItems()
Returns the legend items for the plot.PlotOrientation
getOrientation()
Returns the orientation of the plot.java.lang.String
getPlotType()
Returns a string describing the type of plot.java.util.Map<java.lang.Integer,ValueAxis>
getRangeAxes()
Returns a map containing the range axes that are assigned to this plot.ValueAxis
getRangeAxis()
Returns the range axis for the plot.ValueAxis
getRangeAxis(int index)
Returns a range axis.int
getRangeAxisCount()
Returns the number of range axes.RectangleEdge
getRangeAxisEdge()
Returns the edge where the primary range axis is located.RectangleEdge
getRangeAxisEdge(int index)
Returns the edge for a range axis.ValueAxis
getRangeAxisForDataset(int index)
Returns the range axis for a dataset.int
getRangeAxisIndex(ValueAxis axis)
Returns the index of the specified axis, or-1
if the axis is not assigned to the plot.AxisLocation
getRangeAxisLocation()
Returns the range axis location.AxisLocation
getRangeAxisLocation(int index)
Returns the location for a range axis.java.awt.Paint
getRangeCrosshairPaint()
Returns the paint used to draw the range crosshair.java.awt.Stroke
getRangeCrosshairStroke()
Returns the pen-style (Stroke
) used to draw the crosshair (if visible).double
getRangeCrosshairValue()
Returns the range crosshair value.java.awt.Paint
getRangeGridlinePaint()
Returns the paint used to draw the grid-lines against the range axis.java.awt.Stroke
getRangeGridlineStroke()
Returns the stroke used to draw the grid-lines against the range axis.java.util.Collection<Marker>
getRangeMarkers(int index, Layer layer)
Returns a collection of range markers for a particular renderer and layer.java.util.Collection
getRangeMarkers(Layer layer)
Returns the list of range markers (read only) for the specified layer.java.awt.Paint
getRangeMinorGridlinePaint()
Returns the paint for the minor grid lines (if any) plotted against the range axis.java.awt.Stroke
getRangeMinorGridlineStroke()
Returns the stroke for the minor grid lines (if any) plotted against the range axis.java.awt.Paint
getRangeZeroBaselinePaint()
Returns the paint for the zero baseline (if any) plotted against the range axis.java.awt.Stroke
getRangeZeroBaselineStroke()
Returns the stroke used for the zero baseline against the range axis.CategoryItemRenderer
getRenderer()
Returns a reference to the renderer for the plot.CategoryItemRenderer
getRenderer(int index)
Returns the renderer at the given index.int
getRendererCount()
Returns the number of renderer slots for this plot.CategoryItemRenderer
getRendererForDataset(CategoryDataset dataset)
Returns the renderer for the specified dataset.private java.util.List<java.lang.Integer>
getRendererIndices(DatasetRenderingOrder order)
Returns the indices of the non-null renderers for the plot, in the specified order.java.util.Map<java.lang.Integer,CategoryItemRenderer>
getRenderers()
Returns a map containing the renderers that are assigned to this plot.SortOrder
getRowRenderingOrder()
Returns the order in which the rows should be rendered.ShadowGenerator
getShadowGenerator()
Returns the shadow generator for the plot, if any.int
getWeight()
Returns the weight for this plot when it is used as a subplot within a combined plot.void
handleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor value.int
hashCode()
int
indexOf(CategoryDataset dataset)
Returns the index of the specified dataset, or-1
if the dataset does not belong to the plot.private java.awt.Rectangle
integerise(java.awt.geom.Rectangle2D rect)
Trims a rectangle to integer coordinates.boolean
isDomainCrosshairVisible()
Returns the flag that controls whether or not the domain crosshair is displayed by the plot.boolean
isDomainGridlinesVisible()
Returns the flag that controls whether the domain grid-lines are visible.boolean
isDomainPannable()
Returnsfalse
always, because the plot cannot be panned along the domain axis/axes.boolean
isDomainZoomable()
Returnsfalse
to indicate that the domain axes are not zoomable.boolean
isRangeCrosshairLockedOnData()
Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.boolean
isRangeCrosshairVisible()
Returns a flag indicating whether or not the range crosshair is visible.boolean
isRangeGridlinesVisible()
Returns the flag that controls whether the range grid-lines are visible.boolean
isRangeMinorGridlinesVisible()
Returnstrue
if the range axis minor grid is visible, andfalse
otherwise.boolean
isRangePannable()
Returnstrue
if panning is enabled for the range axes, andfalse
otherwise.boolean
isRangeZeroBaselineVisible()
Returns a flag that controls whether or not a zero baseline is displayed for the range axis.boolean
isRangeZoomable()
Returnstrue
to indicate that the range axes are zoomable.void
mapDatasetToDomainAxes(int index, java.util.List<java.lang.Integer> axisIndices)
Maps the specified dataset to the axes in the list.void
mapDatasetToDomainAxis(int index, int axisIndex)
Maps a dataset to a particular domain axis.void
mapDatasetToRangeAxes(int index, java.util.List<java.lang.Integer> axisIndices)
Maps the specified dataset to the axes in the list.void
mapDatasetToRangeAxis(int index, int axisIndex)
Maps a dataset to a particular range axis.void
panDomainAxes(double percent, PlotRenderingInfo info, java.awt.geom.Point2D source)
Pans the domain axes by the specified percentage.void
panRangeAxes(double percent, PlotRenderingInfo info, java.awt.geom.Point2D source)
Pans the range axes by the specified percentage.private void
readObject(java.io.ObjectInputStream stream)
Provides serialization support.boolean
removeAnnotation(CategoryAnnotation annotation)
Removes an annotation from the plot and sends aPlotChangeEvent
to all registered listeners.boolean
removeAnnotation(CategoryAnnotation annotation, boolean notify)
Removes an annotation from the plot and, if requested, sends aPlotChangeEvent
to all registered listeners.boolean
removeDomainMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.boolean
removeDomainMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and, if requested, sends aPlotChangeEvent
to all registered listeners.boolean
removeDomainMarker(Marker marker)
Removes a marker for the domain axis and sends aPlotChangeEvent
to all registered listeners.boolean
removeDomainMarker(Marker marker, Layer layer)
Removes a marker for the domain axis in the specified layer and sends aPlotChangeEvent
to all registered listeners.boolean
removeRangeMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.boolean
removeRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.boolean
removeRangeMarker(Marker marker)
Removes a marker for the range axis and sends aPlotChangeEvent
to all registered listeners.boolean
removeRangeMarker(Marker marker, Layer layer)
Removes a marker for the range axis in the specified layer and sends aPlotChangeEvent
to all registered listeners.boolean
render(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, PlotRenderingInfo info, CategoryCrosshairState crosshairState)
Draws a representation of a dataset within the dataArea region using the appropriate renderer.void
rendererChanged(RendererChangeEvent event)
Receives notification of a renderer change event.void
setAnchorValue(double value)
Sets the anchor value and sends aPlotChangeEvent
to all registered listeners.void
setAnchorValue(double value, boolean notify)
Sets the anchor value and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setAxisOffset(RectangleInsets offset)
Sets the axis offsets (gap between the data area and the axes) and sends aPlotChangeEvent
to all registered listeners.void
setColumnRenderingOrder(SortOrder order)
Sets the column order in which the items in each dataset should be rendered and sends aPlotChangeEvent
to all registered listeners.void
setCrosshairDatasetIndex(int index)
Sets the dataset index for the crosshair and sends aPlotChangeEvent
to all registered listeners.void
setCrosshairDatasetIndex(int index, boolean notify)
Sets the dataset index for the crosshair and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setDataset(int index, CategoryDataset dataset)
Sets a dataset for the plot and sends a change notification to all registered listeners.void
setDataset(CategoryDataset dataset)
Sets the dataset for the plot, replacing the existing dataset, if there is one.void
setDatasetRenderingOrder(DatasetRenderingOrder order)
Sets the rendering order and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxes(CategoryAxis[] axes)
Sets the domain axes for this plot and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxis(int index, CategoryAxis axis)
Sets a domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxis(int index, CategoryAxis axis, boolean notify)
Sets a domain axis and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setDomainAxis(CategoryAxis axis)
Sets the domain axis for the plot and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(int index, AxisLocation location)
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(int index, AxisLocation location, boolean notify)
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(AxisLocation location)
Sets the location of the domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(AxisLocation location, boolean notify)
Sets the location of the domain axis and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setDomainCrosshairColumnKey(java.lang.Comparable key)
Sets the column key for the domain crosshair and sends aPlotChangeEvent
to all registered listeners.void
setDomainCrosshairColumnKey(java.lang.Comparable key, boolean notify)
Sets the column key for the domain crosshair and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setDomainCrosshairPaint(java.awt.Paint paint)
Sets the paint used to draw the domain crosshair.void
setDomainCrosshairRowKey(java.lang.Comparable key)
Sets the row key for the domain crosshair and sends a {PlotChangeEvent} to all registered listeners.void
setDomainCrosshairRowKey(java.lang.Comparable key, boolean notify)
Sets the row key for the domain crosshair and, if requested, sends a {PlotChangeEvent} to all registered listeners.void
setDomainCrosshairStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the domain crosshair, and sends aPlotChangeEvent
to all registered listeners.void
setDomainCrosshairVisible(boolean flag)
Sets the flag that controls whether or not the domain crosshair is displayed by the plot, and sends aPlotChangeEvent
to all registered listeners.void
setDomainGridlinePaint(java.awt.Paint paint)
Sets the paint used to draw the grid-lines (if any) against the domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainGridlinePosition(CategoryAnchor position)
Sets the position used for the domain gridlines and sends aPlotChangeEvent
to all registered listeners.void
setDomainGridlineStroke(java.awt.Stroke stroke)
Sets the stroke used to draw grid-lines against the domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the domain axis.void
setDrawSharedDomainAxis(boolean draw)
Sets the flag that controls whether the shared domain axis is drawn when this plot is being used as a subplot.void
setFixedDomainAxisSpace(AxisSpace space)
Sets the fixed domain axis space and sends aPlotChangeEvent
to all registered listeners.void
setFixedDomainAxisSpace(AxisSpace space, boolean notify)
Sets the fixed domain axis space and sends aPlotChangeEvent
to all registered listeners.void
setFixedLegendItems(LegendItemCollection items)
Sets the fixed legend items for the plot.void
setFixedRangeAxisSpace(AxisSpace space)
Sets the fixed range axis space and sends aPlotChangeEvent
to all registered listeners.void
setFixedRangeAxisSpace(AxisSpace space, boolean notify)
Sets the fixed range axis space and sends aPlotChangeEvent
to all registered listeners.void
setOrientation(PlotOrientation orientation)
Sets the orientation for the plot and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxes(ValueAxis[] axes)
Sets the range axes for this plot and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxis(int index, ValueAxis axis)
Sets a range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxis(int index, ValueAxis axis, boolean notify)
Sets a range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setRangeAxis(ValueAxis axis)
Sets the range axis for the plot and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(int index, AxisLocation location)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(int index, AxisLocation location, boolean notify)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(AxisLocation location)
Sets the location of the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(AxisLocation location, boolean notify)
Sets the location of the range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairLockedOnData(boolean flag)
Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values, and sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairPaint(java.awt.Paint paint)
Sets the paint used to draw the range crosshair (if visible) and sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairStroke(java.awt.Stroke stroke)
Sets the pen-style (Stroke
) used to draw the range crosshair (if visible), and sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairValue(double value)
Sets the range crosshair value and, if the crosshair is visible, sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairValue(double value, boolean notify)
Sets the range crosshair value and, if requested, sends aPlotChangeEvent
to all registered listeners (but only if the crosshair is visible).void
setRangeCrosshairVisible(boolean flag)
Sets the flag indicating whether or not the range crosshair is visible.void
setRangeGridlinePaint(java.awt.Paint paint)
Sets the paint used to draw the grid lines against the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeGridlineStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the grid-lines against the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the range axis.void
setRangeMinorGridlinePaint(java.awt.Paint paint)
Sets the paint for the minor grid lines plotted against the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeMinorGridlineStroke(java.awt.Stroke stroke)
Sets the stroke for the minor grid lines plotted against the range axis, and sends aPlotChangeEvent
to all registered listeners.void
setRangeMinorGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the range axis minor grid lines are visible.void
setRangePannable(boolean pannable)
Sets the flag that enables or disables panning of the plot along the range axes.void
setRangeZeroBaselinePaint(java.awt.Paint paint)
Sets the paint for the zero baseline plotted against the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeZeroBaselineStroke(java.awt.Stroke stroke)
Sets the stroke for the zero baseline for the range axis, and sends aPlotChangeEvent
to all registered listeners.void
setRangeZeroBaselineVisible(boolean visible)
Sets the flag that controls whether or not the zero baseline is displayed for the range axis, and sends aPlotChangeEvent
to all registered listeners.void
setRenderer(int index, CategoryItemRenderer renderer)
Sets the renderer to use for the dataset with the specified index and sends a change event to all registered listeners.void
setRenderer(int index, CategoryItemRenderer renderer, boolean notify)
Sets the renderer to use for the dataset with the specified index and, if requested, sends a change event to all registered listeners.void
setRenderer(CategoryItemRenderer renderer)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and sends a change event to all registered listeners.void
setRenderer(CategoryItemRenderer renderer, boolean notify)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and, if requested, sends a change event to all registered listeners.void
setRenderers(CategoryItemRenderer[] renderers)
Sets the renderers for this plot and sends aPlotChangeEvent
to all registered listeners.void
setRowRenderingOrder(SortOrder order)
Sets the row order in which the items in each dataset should be rendered and sends aPlotChangeEvent
to all registered listeners.void
setShadowGenerator(ShadowGenerator generator)
Sets the shadow generator for the plot and sends aPlotChangeEvent
to all registered listeners.void
setWeight(int weight)
Sets the weight for the plot and sends aPlotChangeEvent
to all registered listeners.private void
writeObject(java.io.ObjectOutputStream stream)
Provides serialization support.void
zoom(double percent)
Zooms (in or out) on the plot's value axis.void
zoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.void
zoomDomainAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.void
zoomDomainAxes(double factor, PlotRenderingInfo info, java.awt.geom.Point2D source, boolean useAnchor)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.void
zoomRangeAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
Zooms in on the range axes.void
zoomRangeAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
Multiplies the range on the range axis/axes by the specified factor.void
zoomRangeAxes(double factor, PlotRenderingInfo info, java.awt.geom.Point2D source, boolean useAnchor)
Multiplies the range on the range axis/axes by the specified factor.-
Methods inherited from class org.jfree.chart.plot.Plot
addChangeListener, axisChanged, createAndAddEntity, drawBackgroundImage, drawNoDataMessage, drawOutline, fetchElementHintingFlag, fillBackground, fillBackground, fireChangeEvent, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getChart, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, isNotify, isOutlineVisible, isSubplot, markerChanged, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setChart, setDatasetGroup, setDrawingSupplier, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setNotify, setOutlinePaint, setOutlineStroke, setOutlineVisible, setParent
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
DEFAULT_DOMAIN_GRIDLINES_VISIBLE
public static final boolean DEFAULT_DOMAIN_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the domain axis.- See Also:
- Constant Field Values
-
DEFAULT_RANGE_GRIDLINES_VISIBLE
public static final boolean DEFAULT_RANGE_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the range axis.- See Also:
- Constant Field Values
-
DEFAULT_GRIDLINE_STROKE
public static final java.awt.Stroke DEFAULT_GRIDLINE_STROKE
The default grid line stroke.
-
DEFAULT_GRIDLINE_PAINT
public static final java.awt.Paint DEFAULT_GRIDLINE_PAINT
The default grid line paint.
-
DEFAULT_VALUE_LABEL_FONT
public static final java.awt.Font DEFAULT_VALUE_LABEL_FONT
The default value label font.
-
DEFAULT_CROSSHAIR_VISIBLE
public static final boolean DEFAULT_CROSSHAIR_VISIBLE
The default crosshair visibility.- See Also:
- Constant Field Values
-
DEFAULT_CROSSHAIR_STROKE
public static final java.awt.Stroke DEFAULT_CROSSHAIR_STROKE
The default crosshair stroke.
-
DEFAULT_CROSSHAIR_PAINT
public static final java.awt.Paint DEFAULT_CROSSHAIR_PAINT
The default crosshair paint.
-
localizationResources
protected static java.util.ResourceBundle localizationResources
The resourceBundle for the localization.
-
orientation
private PlotOrientation orientation
The plot orientation.
-
axisOffset
private RectangleInsets axisOffset
The offset between the data area and the axes.
-
domainAxes
private java.util.Map<java.lang.Integer,CategoryAxis> domainAxes
Storage for the domain axes.
-
domainAxisLocations
private java.util.Map<java.lang.Integer,AxisLocation> domainAxisLocations
Storage for the domain axis locations.
-
drawSharedDomainAxis
private boolean drawSharedDomainAxis
A flag that controls whether or not the shared domain axis is drawn (only relevant when the plot is being used as a subplot).
-
rangeAxes
private java.util.Map<java.lang.Integer,ValueAxis> rangeAxes
Storage for the range axes.
-
rangeAxisLocations
private java.util.Map<java.lang.Integer,AxisLocation> rangeAxisLocations
Storage for the range axis locations.
-
datasets
private java.util.Map<java.lang.Integer,CategoryDataset> datasets
Storage for the datasets.
-
datasetToDomainAxesMap
private java.util.TreeMap<java.lang.Integer,java.util.List<java.lang.Integer>> datasetToDomainAxesMap
Storage for keys that map each dataset to one or more domain axes. Typically a dataset is rendered using the scale of a single axis, but a dataset can contribute to the "auto-range" of any number of axes.
-
datasetToRangeAxesMap
private java.util.TreeMap<java.lang.Integer,java.util.List<java.lang.Integer>> datasetToRangeAxesMap
Storage for keys that map each dataset to one or more range axes. Typically a dataset is rendered using the scale of a single axis, but a dataset can contribute to the "auto-range" of any number of axes.
-
renderers
private java.util.Map<java.lang.Integer,CategoryItemRenderer> renderers
Storage for the renderers.
-
renderingOrder
private DatasetRenderingOrder renderingOrder
The dataset rendering order.
-
columnRenderingOrder
private SortOrder columnRenderingOrder
Controls the order in which the columns are traversed when rendering the data items.
-
rowRenderingOrder
private SortOrder rowRenderingOrder
Controls the order in which the rows are traversed when rendering the data items.
-
domainGridlinesVisible
private boolean domainGridlinesVisible
A flag that controls whether the grid-lines for the domain axis are visible.
-
domainGridlinePosition
private CategoryAnchor domainGridlinePosition
The position of the domain gridlines relative to the category.
-
domainGridlineStroke
private transient java.awt.Stroke domainGridlineStroke
The stroke used to draw the domain grid-lines.
-
domainGridlinePaint
private transient java.awt.Paint domainGridlinePaint
The paint used to draw the domain grid-lines.
-
rangeZeroBaselineVisible
private boolean rangeZeroBaselineVisible
A flag that controls whether or not the zero baseline against the range axis is visible.
-
rangeZeroBaselineStroke
private transient java.awt.Stroke rangeZeroBaselineStroke
The stroke used for the zero baseline against the range axis.
-
rangeZeroBaselinePaint
private transient java.awt.Paint rangeZeroBaselinePaint
The paint used for the zero baseline against the range axis.
-
rangeGridlinesVisible
private boolean rangeGridlinesVisible
A flag that controls whether the grid-lines for the range axis are visible.
-
rangeGridlineStroke
private transient java.awt.Stroke rangeGridlineStroke
The stroke used to draw the range axis grid-lines.
-
rangeGridlinePaint
private transient java.awt.Paint rangeGridlinePaint
The paint used to draw the range axis grid-lines.
-
rangeMinorGridlinesVisible
private boolean rangeMinorGridlinesVisible
A flag that controls whether or not gridlines are shown for the minor tick values on the primary range axis.
-
rangeMinorGridlineStroke
private transient java.awt.Stroke rangeMinorGridlineStroke
The stroke used to draw the range minor grid-lines.
-
rangeMinorGridlinePaint
private transient java.awt.Paint rangeMinorGridlinePaint
The paint used to draw the range minor grid-lines.
-
anchorValue
private double anchorValue
The anchor value.
-
crosshairDatasetIndex
private int crosshairDatasetIndex
The index for the dataset that the crosshairs are linked to (this determines which axes the crosshairs are plotted against).
-
domainCrosshairVisible
private boolean domainCrosshairVisible
A flag that controls the visibility of the domain crosshair.
-
domainCrosshairRowKey
private java.lang.Comparable domainCrosshairRowKey
The row key for the crosshair point.
-
domainCrosshairColumnKey
private java.lang.Comparable domainCrosshairColumnKey
The column key for the crosshair point.
-
domainCrosshairStroke
private transient java.awt.Stroke domainCrosshairStroke
The stroke used to draw the domain crosshair if it is visible.
-
domainCrosshairPaint
private transient java.awt.Paint domainCrosshairPaint
The paint used to draw the domain crosshair if it is visible.
-
rangeCrosshairVisible
private boolean rangeCrosshairVisible
A flag that controls whether or not a range crosshair is drawn.
-
rangeCrosshairValue
private double rangeCrosshairValue
The range crosshair value.
-
rangeCrosshairStroke
private transient java.awt.Stroke rangeCrosshairStroke
The pen/brush used to draw the crosshair (if any).
-
rangeCrosshairPaint
private transient java.awt.Paint rangeCrosshairPaint
The color used to draw the crosshair (if any).
-
rangeCrosshairLockedOnData
private boolean rangeCrosshairLockedOnData
A flag that controls whether or not the crosshair locks onto actual data points.
-
foregroundDomainMarkers
private java.util.Map<java.lang.Integer,java.util.Collection<CategoryMarker>> foregroundDomainMarkers
A map containing lists of markers for the domain axes.
-
backgroundDomainMarkers
private java.util.Map<java.lang.Integer,java.util.Collection<CategoryMarker>> backgroundDomainMarkers
A map containing lists of markers for the domain axes.
-
foregroundRangeMarkers
private java.util.Map<java.lang.Integer,java.util.Collection<Marker>> foregroundRangeMarkers
A map containing lists of markers for the range axes.
-
backgroundRangeMarkers
private java.util.Map<java.lang.Integer,java.util.Collection<Marker>> backgroundRangeMarkers
A map containing lists of markers for the range axes.
-
annotations
private java.util.List<CategoryAnnotation> annotations
A (possibly empty) list of annotations for the plot. The list should be initialised in the constructor and never allowed to benull
.
-
weight
private int weight
The weight for the plot (only relevant when the plot is used as a subplot within a combined plot).
-
fixedDomainAxisSpace
private AxisSpace fixedDomainAxisSpace
The fixed space for the domain axis.
-
fixedRangeAxisSpace
private AxisSpace fixedRangeAxisSpace
The fixed space for the range axis.
-
fixedLegendItems
private LegendItemCollection fixedLegendItems
An optional collection of legend items that can be returned by the getLegendItems() method.
-
rangePannable
private boolean rangePannable
A flag that controls whether or not panning is enabled for the range axis/axes.
-
shadowGenerator
private ShadowGenerator shadowGenerator
The shadow generator for the plot (null
permitted).
-
-
Constructor Detail
-
CategoryPlot
public CategoryPlot()
Default constructor.
-
CategoryPlot
public CategoryPlot(CategoryDataset dataset, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryItemRenderer renderer)
Creates a new plot.- Parameters:
dataset
- the dataset (null
permitted).domainAxis
- the domain axis (null
permitted).rangeAxis
- the range axis (null
permitted).renderer
- the item renderer (null
permitted).
-
-
Method Detail
-
getPlotType
public java.lang.String getPlotType()
Returns a string describing the type of plot.- Specified by:
getPlotType
in classPlot
- Returns:
- The type.
-
getOrientation
public PlotOrientation getOrientation()
Returns the orientation of the plot.- Specified by:
getOrientation
in interfacePannable
- Specified by:
getOrientation
in interfaceZoomable
- Returns:
- The orientation of the plot (never
null
). - See Also:
setOrientation(PlotOrientation)
-
setOrientation
public void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
orientation
- the orientation (null
not permitted).- See Also:
getOrientation()
-
getAxisOffset
public RectangleInsets getAxisOffset()
Returns the axis offset.- Returns:
- The axis offset (never
null
). - See Also:
setAxisOffset(RectangleInsets)
-
setAxisOffset
public void setAxisOffset(RectangleInsets offset)
Sets the axis offsets (gap between the data area and the axes) and sends aPlotChangeEvent
to all registered listeners.- Parameters:
offset
- the offset (null
not permitted).- See Also:
getAxisOffset()
-
getDomainAxis
public CategoryAxis getDomainAxis()
Returns the domain axis for the plot. If the domain axis for this plot isnull
, then the method will return the parent plot's domain axis (if there is a parent plot).- Returns:
- The domain axis (
null
permitted). - See Also:
setDomainAxis(CategoryAxis)
-
getDomainAxis
public CategoryAxis getDomainAxis(int index)
Returns a domain axis.- Parameters:
index
- the axis index.- Returns:
- The axis (
null
possible). - See Also:
setDomainAxis(int, CategoryAxis)
-
getDomainAxes
public java.util.Map<java.lang.Integer,CategoryAxis> getDomainAxes()
Returns a map containing the domain axes that are assigned to this plot. The map is unmodifiable.- Returns:
- A map containing the domain axes that are assigned to the plot
(never
null
). - Since:
- 1.5.4
-
setDomainAxis
public void setDomainAxis(CategoryAxis axis)
Sets the domain axis for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axis
- the axis (null
permitted).- See Also:
getDomainAxis()
-
setDomainAxis
public void setDomainAxis(int index, CategoryAxis axis)
Sets a domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.axis
- the axis (null
permitted).- See Also:
getDomainAxis(int)
-
setDomainAxis
public void setDomainAxis(int index, CategoryAxis axis, boolean notify)
Sets a domain axis and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.axis
- the axis (null
permitted).notify
- notify listeners?
-
setDomainAxes
public void setDomainAxes(CategoryAxis[] axes)
Sets the domain axes for this plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axes
- the axes (null
not permitted).- See Also:
setRangeAxes(ValueAxis[])
-
getDomainAxisIndex
public int getDomainAxisIndex(CategoryAxis axis)
Returns the index of the specified axis, or-1
if the axis is not assigned to the plot.- Parameters:
axis
- the axis (null
not permitted).- Returns:
- The axis index.
- See Also:
getDomainAxis(int)
,getRangeAxisIndex(ValueAxis)
-
getDomainAxisLocation
public AxisLocation getDomainAxisLocation()
Returns the domain axis location for the primary domain axis.- Returns:
- The location (never
null
). - See Also:
getRangeAxisLocation()
-
getDomainAxisLocation
public AxisLocation getDomainAxisLocation(int index)
Returns the location for a domain axis.- Parameters:
index
- the axis index.- Returns:
- The location.
- See Also:
setDomainAxisLocation(int, AxisLocation)
-
setDomainAxisLocation
public void setDomainAxisLocation(AxisLocation location)
Sets the location of the domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the axis location (null
not permitted).- See Also:
getDomainAxisLocation()
,setDomainAxisLocation(int, AxisLocation)
-
setDomainAxisLocation
public void setDomainAxisLocation(AxisLocation location, boolean notify)
Sets the location of the domain axis and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the axis location (null
not permitted).notify
- a flag that controls whether listeners are notified.
-
setDomainAxisLocation
public void setDomainAxisLocation(int index, AxisLocation location)
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.- See Also:
getDomainAxisLocation(int)
,setRangeAxisLocation(int, AxisLocation)
-
setDomainAxisLocation
public void setDomainAxisLocation(int index, AxisLocation location, boolean notify)
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.notify
- notify listeners?- See Also:
getDomainAxisLocation(int)
,setRangeAxisLocation(int, AxisLocation, boolean)
-
getDomainAxisEdge
public RectangleEdge getDomainAxisEdge()
Returns the domain axis edge. This is derived from the axis location and the plot orientation.- Returns:
- The edge (never
null
).
-
getDomainAxisEdge
public RectangleEdge getDomainAxisEdge(int index)
Returns the edge for a domain axis.- Parameters:
index
- the axis index.- Returns:
- The edge (never
null
).
-
getDomainAxisCount
public int getDomainAxisCount()
Returns the number of domain axes.- Returns:
- The axis count.
-
clearDomainAxes
public void clearDomainAxes()
Clears the domain axes from the plot and sends aPlotChangeEvent
to all registered listeners.
-
configureDomainAxes
public void configureDomainAxes()
Configures the domain axes.
-
getRangeAxis
public ValueAxis getRangeAxis()
Returns the range axis for the plot. If the range axis for this plot is null, then the method will return the parent plot's range axis (if there is a parent plot).- Returns:
- The range axis (possibly
null
).
-
getRangeAxis
public ValueAxis getRangeAxis(int index)
Returns a range axis.- Parameters:
index
- the axis index.- Returns:
- The axis (
null
possible).
-
getRangeAxes
public java.util.Map<java.lang.Integer,ValueAxis> getRangeAxes()
Returns a map containing the range axes that are assigned to this plot. The map is unmodifiable.- Returns:
- A map containing the domain axes that are assigned to the plot
(never
null
). - Since:
- 1.5.4
-
setRangeAxis
public void setRangeAxis(ValueAxis axis)
Sets the range axis for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axis
- the axis (null
permitted).
-
setRangeAxis
public void setRangeAxis(int index, ValueAxis axis)
Sets a range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.axis
- the axis.
-
setRangeAxis
public void setRangeAxis(int index, ValueAxis axis, boolean notify)
Sets a range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.axis
- the axis.notify
- notify listeners?
-
setRangeAxes
public void setRangeAxes(ValueAxis[] axes)
Sets the range axes for this plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axes
- the axes (null
not permitted).- See Also:
setDomainAxes(CategoryAxis[])
-
getRangeAxisIndex
public int getRangeAxisIndex(ValueAxis axis)
Returns the index of the specified axis, or-1
if the axis is not assigned to the plot.- Parameters:
axis
- the axis (null
not permitted).- Returns:
- The axis index.
- See Also:
getRangeAxis(int)
,getDomainAxisIndex(CategoryAxis)
-
findRangeAxisIndex
private int findRangeAxisIndex(ValueAxis axis)
-
getRangeAxisLocation
public AxisLocation getRangeAxisLocation()
Returns the range axis location.- Returns:
- The location (never
null
).
-
getRangeAxisLocation
public AxisLocation getRangeAxisLocation(int index)
Returns the location for a range axis.- Parameters:
index
- the axis index.- Returns:
- The location.
- See Also:
setRangeAxisLocation(int, AxisLocation)
-
setRangeAxisLocation
public void setRangeAxisLocation(AxisLocation location)
Sets the location of the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the location (null
not permitted).- See Also:
setRangeAxisLocation(AxisLocation, boolean)
,setDomainAxisLocation(AxisLocation)
-
setRangeAxisLocation
public void setRangeAxisLocation(AxisLocation location, boolean notify)
Sets the location of the range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the location (null
not permitted).notify
- notify listeners?- See Also:
setDomainAxisLocation(AxisLocation, boolean)
-
setRangeAxisLocation
public void setRangeAxisLocation(int index, AxisLocation location)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.- See Also:
getRangeAxisLocation(int)
,setRangeAxisLocation(int, AxisLocation, boolean)
-
setRangeAxisLocation
public void setRangeAxisLocation(int index, AxisLocation location, boolean notify)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.notify
- notify listeners?- See Also:
getRangeAxisLocation(int)
,setDomainAxisLocation(int, AxisLocation, boolean)
-
getRangeAxisEdge
public RectangleEdge getRangeAxisEdge()
Returns the edge where the primary range axis is located.- Returns:
- The edge (never
null
).
-
getRangeAxisEdge
public RectangleEdge getRangeAxisEdge(int index)
Returns the edge for a range axis.- Parameters:
index
- the axis index.- Returns:
- The edge.
-
getRangeAxisCount
public int getRangeAxisCount()
Returns the number of range axes.- Returns:
- The axis count.
-
clearRangeAxes
public void clearRangeAxes()
Clears the range axes from the plot and sends aPlotChangeEvent
to all registered listeners.
-
configureRangeAxes
public void configureRangeAxes()
Configures the range axes.
-
getDataset
public CategoryDataset getDataset()
Returns the primary dataset for the plot.- Returns:
- The primary dataset (possibly
null
). - See Also:
setDataset(CategoryDataset)
-
getDataset
public CategoryDataset getDataset(int index)
Returns the dataset with the given index, ornull
if there is no dataset.- Parameters:
index
- the dataset index (must be >= 0).- Returns:
- The dataset (possibly
null
). - See Also:
setDataset(int, CategoryDataset)
-
getDatasets
public java.util.Map<java.lang.Integer,CategoryDataset> getDatasets()
Returns a map containing the datasets that are assigned to this plot. The map is unmodifiable.- Returns:
- A map containing the datasets that are assigned to the plot
(never
null
). - Since:
- 1.5.4
-
setDataset
public void setDataset(CategoryDataset dataset)
Sets the dataset for the plot, replacing the existing dataset, if there is one. This method also calls thedatasetChanged(DatasetChangeEvent)
method, which adjusts the axis ranges if necessary and sends aPlotChangeEvent
to all registered listeners.- Parameters:
dataset
- the dataset (null
permitted).- See Also:
getDataset()
-
setDataset
public void setDataset(int index, CategoryDataset dataset)
Sets a dataset for the plot and sends a change notification to all registered listeners.- Parameters:
index
- the dataset index (must be >= 0).dataset
- the dataset (null
permitted).- See Also:
getDataset(int)
-
getDatasetCount
public int getDatasetCount()
Returns the number of datasets.- Returns:
- The number of datasets.
-
indexOf
public int indexOf(CategoryDataset dataset)
Returns the index of the specified dataset, or-1
if the dataset does not belong to the plot.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The index.
-
mapDatasetToDomainAxis
public void mapDatasetToDomainAxis(int index, int axisIndex)
Maps a dataset to a particular domain axis.- Parameters:
index
- the dataset index (zero-based).axisIndex
- the axis index (zero-based).- See Also:
getDomainAxisForDataset(int)
-
mapDatasetToDomainAxes
public void mapDatasetToDomainAxes(int index, java.util.List<java.lang.Integer> axisIndices)
Maps the specified dataset to the axes in the list. Note that the conversion of data values into Java2D space is always performed using the first axis in the list.- Parameters:
index
- the dataset index (zero-based).axisIndices
- the axis indices (null
permitted).
-
checkAxisIndices
private void checkAxisIndices(java.util.List<java.lang.Integer> indices)
This method is used to perform argument checking on the list of axis indices passed to mapDatasetToDomainAxes() and mapDatasetToRangeAxes().- Parameters:
indices
- the list of indices (null
permitted).
-
getDomainAxisForDataset
public CategoryAxis getDomainAxisForDataset(int index)
Returns the domain axis for a dataset. You can change the axis for a dataset using themapDatasetToDomainAxis(int, int)
method.- Parameters:
index
- the dataset index (must be >= 0).- Returns:
- The domain axis.
- See Also:
mapDatasetToDomainAxis(int, int)
-
mapDatasetToRangeAxis
public void mapDatasetToRangeAxis(int index, int axisIndex)
Maps a dataset to a particular range axis.- Parameters:
index
- the dataset index (zero-based).axisIndex
- the axis index (zero-based).- See Also:
getRangeAxisForDataset(int)
-
mapDatasetToRangeAxes
public void mapDatasetToRangeAxes(int index, java.util.List<java.lang.Integer> axisIndices)
Maps the specified dataset to the axes in the list. Note that the conversion of data values into Java2D space is always performed using the first axis in the list.- Parameters:
index
- the dataset index (zero-based).axisIndices
- the axis indices (null
permitted).
-
getRangeAxisForDataset
public ValueAxis getRangeAxisForDataset(int index)
Returns the range axis for a dataset. You can change the axis for a dataset using themapDatasetToRangeAxis(int, int)
method.- Parameters:
index
- the dataset index (must be >= 0).- Returns:
- The range axis.
- See Also:
mapDatasetToRangeAxis(int, int)
-
getRendererCount
public int getRendererCount()
Returns the number of renderer slots for this plot.- Returns:
- The number of renderer slots.
-
getRenderer
public CategoryItemRenderer getRenderer()
Returns a reference to the renderer for the plot.- Returns:
- The renderer.
- See Also:
setRenderer(CategoryItemRenderer)
-
getRenderer
public CategoryItemRenderer getRenderer(int index)
Returns the renderer at the given index.- Parameters:
index
- the renderer index.- Returns:
- The renderer (possibly
null
). - See Also:
setRenderer(int, CategoryItemRenderer)
-
getRenderers
public java.util.Map<java.lang.Integer,CategoryItemRenderer> getRenderers()
Returns a map containing the renderers that are assigned to this plot. The map is unmodifiable.- Returns:
- A map containing the renderers that are assigned to the plot
(never
null
). - Since:
- 1.5.4
-
setRenderer
public void setRenderer(CategoryItemRenderer renderer)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and sends a change event to all registered listeners.- Parameters:
renderer
- the renderer (null
permitted.- See Also:
getRenderer()
-
setRenderer
public void setRenderer(CategoryItemRenderer renderer, boolean notify)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and, if requested, sends a change event to all registered listeners.You can set the renderer to
null
, but this is not recommended because:- no data will be displayed;
- the plot background will not be painted;
- Parameters:
renderer
- the renderer (null
permitted).notify
- notify listeners?- See Also:
getRenderer()
-
setRenderer
public void setRenderer(int index, CategoryItemRenderer renderer)
Sets the renderer to use for the dataset with the specified index and sends a change event to all registered listeners. Note that each dataset should have its own renderer, you should not use one renderer for multiple datasets.- Parameters:
index
- the index.renderer
- the renderer (null
permitted).- See Also:
getRenderer(int)
,setRenderer(int, CategoryItemRenderer, boolean)
-
setRenderer
public void setRenderer(int index, CategoryItemRenderer renderer, boolean notify)
Sets the renderer to use for the dataset with the specified index and, if requested, sends a change event to all registered listeners. Note that each dataset should have its own renderer, you should not use one renderer for multiple datasets.- Parameters:
index
- the index.renderer
- the renderer (null
permitted).notify
- notify listeners?- See Also:
getRenderer(int)
-
setRenderers
public void setRenderers(CategoryItemRenderer[] renderers)
Sets the renderers for this plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
renderers
- the renderers.
-
getRendererForDataset
public CategoryItemRenderer getRendererForDataset(CategoryDataset dataset)
Returns the renderer for the specified dataset. If the dataset doesn't belong to the plot, this method will returnnull
.- Parameters:
dataset
- the dataset (null
permitted).- Returns:
- The renderer (possibly
null
).
-
getIndexOf
public int getIndexOf(CategoryItemRenderer renderer)
Returns the index of the specified renderer, or-1
if the renderer is not assigned to this plot.- Parameters:
renderer
- the renderer (null
permitted).- Returns:
- The renderer index.
-
getDatasetRenderingOrder
public DatasetRenderingOrder getDatasetRenderingOrder()
Returns the dataset rendering order.- Returns:
- The order (never
null
). - See Also:
setDatasetRenderingOrder(DatasetRenderingOrder)
-
setDatasetRenderingOrder
public void setDatasetRenderingOrder(DatasetRenderingOrder order)
Sets the rendering order and sends aPlotChangeEvent
to all registered listeners. By default, the plot renders the primary dataset last (so that the primary dataset overlays the secondary datasets). You can reverse this if you want to.- Parameters:
order
- the rendering order (null
not permitted).- See Also:
getDatasetRenderingOrder()
-
getColumnRenderingOrder
public SortOrder getColumnRenderingOrder()
Returns the order in which the columns are rendered. The default value isSortOrder.ASCENDING
.- Returns:
- The column rendering order (never
null
). - See Also:
setColumnRenderingOrder(SortOrder)
-
setColumnRenderingOrder
public void setColumnRenderingOrder(SortOrder order)
Sets the column order in which the items in each dataset should be rendered and sends aPlotChangeEvent
to all registered listeners. Note that this affects the order in which items are drawn, NOT their position in the chart.- Parameters:
order
- the order (null
not permitted).- See Also:
getColumnRenderingOrder()
,setRowRenderingOrder(SortOrder)
-
getRowRenderingOrder
public SortOrder getRowRenderingOrder()
Returns the order in which the rows should be rendered. The default value isSortOrder.ASCENDING
.- Returns:
- The order (never
null
). - See Also:
setRowRenderingOrder(SortOrder)
-
setRowRenderingOrder
public void setRowRenderingOrder(SortOrder order)
Sets the row order in which the items in each dataset should be rendered and sends aPlotChangeEvent
to all registered listeners. Note that this affects the order in which items are drawn, NOT their position in the chart.- Parameters:
order
- the order (null
not permitted).- See Also:
getRowRenderingOrder()
,setColumnRenderingOrder(SortOrder)
-
isDomainGridlinesVisible
public boolean isDomainGridlinesVisible()
Returns the flag that controls whether the domain grid-lines are visible.- Returns:
- The
true
orfalse
. - See Also:
setDomainGridlinesVisible(boolean)
-
setDomainGridlinesVisible
public void setDomainGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the domain axis.If the flag value changes, a
PlotChangeEvent
is sent to all registered listeners.- Parameters:
visible
- the new value of the flag.- See Also:
isDomainGridlinesVisible()
-
getDomainGridlinePosition
public CategoryAnchor getDomainGridlinePosition()
Returns the position used for the domain gridlines.- Returns:
- The gridline position (never
null
). - See Also:
setDomainGridlinePosition(CategoryAnchor)
-
setDomainGridlinePosition
public void setDomainGridlinePosition(CategoryAnchor position)
Sets the position used for the domain gridlines and sends aPlotChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
not permitted).- See Also:
getDomainGridlinePosition()
-
getDomainGridlineStroke
public java.awt.Stroke getDomainGridlineStroke()
Returns the stroke used to draw grid-lines against the domain axis.- Returns:
- The stroke (never
null
). - See Also:
setDomainGridlineStroke(Stroke)
-
setDomainGridlineStroke
public void setDomainGridlineStroke(java.awt.Stroke stroke)
Sets the stroke used to draw grid-lines against the domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getDomainGridlineStroke()
-
getDomainGridlinePaint
public java.awt.Paint getDomainGridlinePaint()
Returns the paint used to draw grid-lines against the domain axis.- Returns:
- The paint (never
null
). - See Also:
setDomainGridlinePaint(Paint)
-
setDomainGridlinePaint
public void setDomainGridlinePaint(java.awt.Paint paint)
Sets the paint used to draw the grid-lines (if any) against the domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getDomainGridlinePaint()
-
isRangeZeroBaselineVisible
public boolean isRangeZeroBaselineVisible()
Returns a flag that controls whether or not a zero baseline is displayed for the range axis.- Returns:
- A boolean.
- See Also:
setRangeZeroBaselineVisible(boolean)
-
setRangeZeroBaselineVisible
public void setRangeZeroBaselineVisible(boolean visible)
Sets the flag that controls whether or not the zero baseline is displayed for the range axis, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
visible
- the flag.- See Also:
isRangeZeroBaselineVisible()
-
getRangeZeroBaselineStroke
public java.awt.Stroke getRangeZeroBaselineStroke()
Returns the stroke used for the zero baseline against the range axis.- Returns:
- The stroke (never
null
). - See Also:
setRangeZeroBaselineStroke(Stroke)
-
setRangeZeroBaselineStroke
public void setRangeZeroBaselineStroke(java.awt.Stroke stroke)
Sets the stroke for the zero baseline for the range axis, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getRangeZeroBaselineStroke()
-
getRangeZeroBaselinePaint
public java.awt.Paint getRangeZeroBaselinePaint()
Returns the paint for the zero baseline (if any) plotted against the range axis.- Returns:
- The paint (never
null
). - See Also:
setRangeZeroBaselinePaint(Paint)
-
setRangeZeroBaselinePaint
public void setRangeZeroBaselinePaint(java.awt.Paint paint)
Sets the paint for the zero baseline plotted against the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getRangeZeroBaselinePaint()
-
isRangeGridlinesVisible
public boolean isRangeGridlinesVisible()
Returns the flag that controls whether the range grid-lines are visible.- Returns:
- The flag.
- See Also:
setRangeGridlinesVisible(boolean)
-
setRangeGridlinesVisible
public void setRangeGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the range axis. If the flag changes value, aPlotChangeEvent
is sent to all registered listeners.- Parameters:
visible
- the new value of the flag.- See Also:
isRangeGridlinesVisible()
-
getRangeGridlineStroke
public java.awt.Stroke getRangeGridlineStroke()
Returns the stroke used to draw the grid-lines against the range axis.- Returns:
- The stroke (never
null
). - See Also:
setRangeGridlineStroke(Stroke)
-
setRangeGridlineStroke
public void setRangeGridlineStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the grid-lines against the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getRangeGridlineStroke()
-
getRangeGridlinePaint
public java.awt.Paint getRangeGridlinePaint()
Returns the paint used to draw the grid-lines against the range axis.- Returns:
- The paint (never
null
). - See Also:
setRangeGridlinePaint(Paint)
-
setRangeGridlinePaint
public void setRangeGridlinePaint(java.awt.Paint paint)
Sets the paint used to draw the grid lines against the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getRangeGridlinePaint()
-
isRangeMinorGridlinesVisible
public boolean isRangeMinorGridlinesVisible()
Returnstrue
if the range axis minor grid is visible, andfalse
otherwise.- Returns:
- A boolean.
- See Also:
setRangeMinorGridlinesVisible(boolean)
-
setRangeMinorGridlinesVisible
public void setRangeMinorGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the range axis minor grid lines are visible.If the flag value is changed, a
PlotChangeEvent
is sent to all registered listeners.- Parameters:
visible
- the new value of the flag.- See Also:
isRangeMinorGridlinesVisible()
-
getRangeMinorGridlineStroke
public java.awt.Stroke getRangeMinorGridlineStroke()
Returns the stroke for the minor grid lines (if any) plotted against the range axis.- Returns:
- The stroke (never
null
). - See Also:
setRangeMinorGridlineStroke(Stroke)
-
setRangeMinorGridlineStroke
public void setRangeMinorGridlineStroke(java.awt.Stroke stroke)
Sets the stroke for the minor grid lines plotted against the range axis, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getRangeMinorGridlineStroke()
-
getRangeMinorGridlinePaint
public java.awt.Paint getRangeMinorGridlinePaint()
Returns the paint for the minor grid lines (if any) plotted against the range axis.- Returns:
- The paint (never
null
). - See Also:
setRangeMinorGridlinePaint(Paint)
-
setRangeMinorGridlinePaint
public void setRangeMinorGridlinePaint(java.awt.Paint paint)
Sets the paint for the minor grid lines plotted against the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getRangeMinorGridlinePaint()
-
getFixedLegendItems
public LegendItemCollection getFixedLegendItems()
Returns the fixed legend items, if any.- Returns:
- The legend items (possibly
null
). - See Also:
setFixedLegendItems(LegendItemCollection)
-
setFixedLegendItems
public void setFixedLegendItems(LegendItemCollection items)
Sets the fixed legend items for the plot. Leave this set tonull
if you prefer the legend items to be created automatically.- Parameters:
items
- the legend items (null
permitted).- See Also:
getFixedLegendItems()
-
getLegendItems
public LegendItemCollection getLegendItems()
Returns the legend items for the plot. By default, this method creates a legend item for each series in each of the datasets. You can change this behaviour by overriding this method.- Specified by:
getLegendItems
in interfaceLegendItemSource
- Overrides:
getLegendItems
in classPlot
- Returns:
- The legend items.
-
handleClick
public void handleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor value.- Overrides:
handleClick
in classPlot
- Parameters:
x
- x-coordinate of the click (in Java2D space).y
- y-coordinate of the click (in Java2D space).info
- information about the plot's dimensions.
-
zoom
public void zoom(double percent)
Zooms (in or out) on the plot's value axis.If the value 0.0 is passed in as the zoom percent, the auto-range calculation for the axis is restored (which sets the range to include the minimum and maximum data values, thus displaying all the data).
-
annotationChanged
public void annotationChanged(AnnotationChangeEvent event)
Receives notification of a change to anAnnotation
added to this plot.- Specified by:
annotationChanged
in interfaceAnnotationChangeListener
- Overrides:
annotationChanged
in classPlot
- Parameters:
event
- information about the event (not used here).
-
datasetChanged
public void datasetChanged(DatasetChangeEvent event)
Receives notification of a change to the plot's dataset.The range axis bounds will be recalculated if necessary.
- Specified by:
datasetChanged
in interfaceDatasetChangeListener
- Overrides:
datasetChanged
in classPlot
- Parameters:
event
- information about the event (not used here).
-
rendererChanged
public void rendererChanged(RendererChangeEvent event)
Receives notification of a renderer change event.- Specified by:
rendererChanged
in interfaceRendererChangeListener
- Parameters:
event
- the event.
-
addDomainMarker
public void addDomainMarker(CategoryMarker marker)
Adds a marker for display (in the foreground) against the domain axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).- See Also:
removeDomainMarker(Marker)
-
addDomainMarker
public void addDomainMarker(CategoryMarker marker, Layer layer)
Adds a marker for display against the domain axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).layer
- the layer (foreground or background) (null
not permitted).- See Also:
removeDomainMarker(Marker, Layer)
-
addDomainMarker
public void addDomainMarker(int index, CategoryMarker marker, Layer layer)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.Typically a marker will be drawn by the renderer as a line perpendicular to a domain axis, however this is entirely up to the renderer.
- Parameters:
index
- the renderer index.marker
- the marker (null
not permitted).layer
- the layer (null
not permitted).- See Also:
removeDomainMarker(int, Marker, Layer)
-
addDomainMarker
public void addDomainMarker(int index, CategoryMarker marker, Layer layer, boolean notify)
Adds a marker for display by a particular renderer and, if requested, sends aPlotChangeEvent
to all registered listeners.Typically a marker will be drawn by the renderer as a line perpendicular to a domain axis, however this is entirely up to the renderer.
- Parameters:
index
- the renderer index.marker
- the marker (null
not permitted).layer
- the layer (null
not permitted).notify
- notify listeners?- See Also:
removeDomainMarker(int, Marker, Layer, boolean)
-
clearDomainMarkers
public void clearDomainMarkers()
Clears all the domain markers for the plot and sends aPlotChangeEvent
to all registered listeners.- See Also:
clearRangeMarkers()
-
getDomainMarkers
public java.util.Collection getDomainMarkers(Layer layer)
Returns the list of domain markers (read only) for the specified layer.- Parameters:
layer
- the layer (foreground or background).- Returns:
- The list of domain markers.
-
getDomainMarkers
public java.util.Collection<CategoryMarker> getDomainMarkers(int index, Layer layer)
Returns a collection of domain markers for a particular renderer and layer.- Parameters:
index
- the renderer index.layer
- the layer.- Returns:
- A collection of markers (possibly
null
).
-
clearDomainMarkers
public void clearDomainMarkers(int index)
Clears all the domain markers for the specified renderer.- Parameters:
index
- the renderer index.- See Also:
clearRangeMarkers(int)
-
removeDomainMarker
public boolean removeDomainMarker(Marker marker)
Removes a marker for the domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
marker
- the marker.- Returns:
- A boolean indicating whether or not the marker was actually removed.
-
removeDomainMarker
public boolean removeDomainMarker(Marker marker, Layer layer)
Removes a marker for the domain axis in the specified layer and sends aPlotChangeEvent
to all registered listeners.- Parameters:
marker
- the marker (null
not permitted).layer
- the layer (foreground or background).- Returns:
- A boolean indicating whether or not the marker was actually removed.
-
removeDomainMarker
public boolean removeDomainMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the dataset/renderer index.marker
- the marker.layer
- the layer (foreground or background).- Returns:
- A boolean indicating whether or not the marker was actually removed.
-
removeDomainMarker
public boolean removeDomainMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the dataset/renderer index.marker
- the marker.layer
- the layer (foreground or background).notify
- notify listeners?- Returns:
- A boolean indicating whether or not the marker was actually removed.
-
addRangeMarker
public void addRangeMarker(Marker marker)
Adds a marker for display (in the foreground) against the range axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).- See Also:
removeRangeMarker(Marker)
-
addRangeMarker
public void addRangeMarker(Marker marker, Layer layer)
Adds a marker for display against the range axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).layer
- the layer (foreground or background) (null
not permitted).- See Also:
removeRangeMarker(Marker, Layer)
-
addRangeMarker
public void addRangeMarker(int index, Marker marker, Layer layer)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.Typically a marker will be drawn by the renderer as a line perpendicular to a range axis, however this is entirely up to the renderer.
- Parameters:
index
- the renderer index.marker
- the marker.layer
- the layer.- See Also:
removeRangeMarker(int, Marker, Layer)
-
addRangeMarker
public void addRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Adds a marker for display by a particular renderer and sends aPlotChangeEvent
to all registered listeners.Typically a marker will be drawn by the renderer as a line perpendicular to a range axis, however this is entirely up to the renderer.
- Parameters:
index
- the renderer index.marker
- the marker.layer
- the layer.notify
- notify listeners?- See Also:
removeRangeMarker(int, Marker, Layer, boolean)
-
clearRangeMarkers
public void clearRangeMarkers()
Clears all the range markers for the plot and sends aPlotChangeEvent
to all registered listeners.- See Also:
clearDomainMarkers()
-
getRangeMarkers
public java.util.Collection getRangeMarkers(Layer layer)
Returns the list of range markers (read only) for the specified layer.- Parameters:
layer
- the layer (foreground or background).- Returns:
- The list of range markers.
- See Also:
getRangeMarkers(int, Layer)
-
getRangeMarkers
public java.util.Collection<Marker> getRangeMarkers(int index, Layer layer)
Returns a collection of range markers for a particular renderer and layer.- Parameters:
index
- the renderer index.layer
- the layer.- Returns:
- A collection of markers (possibly
null
).
-
clearRangeMarkers
public void clearRangeMarkers(int index)
Clears all the range markers for the specified renderer.- Parameters:
index
- the renderer index.- See Also:
clearDomainMarkers(int)
-
removeRangeMarker
public boolean removeRangeMarker(Marker marker)
Removes a marker for the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
marker
- the marker.- Returns:
- A boolean indicating whether or not the marker was actually removed.
- See Also:
addRangeMarker(Marker)
-
removeRangeMarker
public boolean removeRangeMarker(Marker marker, Layer layer)
Removes a marker for the range axis in the specified layer and sends aPlotChangeEvent
to all registered listeners.- Parameters:
marker
- the marker (null
not permitted).layer
- the layer (foreground or background).- Returns:
- A boolean indicating whether or not the marker was actually removed.
- See Also:
addRangeMarker(Marker, Layer)
-
removeRangeMarker
public boolean removeRangeMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the dataset/renderer index.marker
- the marker.layer
- the layer (foreground or background).- Returns:
- A boolean indicating whether or not the marker was actually removed.
- See Also:
addRangeMarker(int, Marker, Layer)
-
removeRangeMarker
public boolean removeRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the dataset/renderer index.marker
- the marker.layer
- the layer (foreground or background).notify
- notify listeners.- Returns:
- A boolean indicating whether or not the marker was actually removed.
- See Also:
addRangeMarker(int, Marker, Layer, boolean)
-
isDomainCrosshairVisible
public boolean isDomainCrosshairVisible()
Returns the flag that controls whether or not the domain crosshair is displayed by the plot.- Returns:
- A boolean.
- See Also:
setDomainCrosshairVisible(boolean)
-
setDomainCrosshairVisible
public void setDomainCrosshairVisible(boolean flag)
Sets the flag that controls whether or not the domain crosshair is displayed by the plot, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
flag
- the new flag value.- See Also:
isDomainCrosshairVisible()
,setRangeCrosshairVisible(boolean)
-
getDomainCrosshairRowKey
public java.lang.Comparable getDomainCrosshairRowKey()
Returns the row key for the domain crosshair.- Returns:
- The row key.
-
setDomainCrosshairRowKey
public void setDomainCrosshairRowKey(java.lang.Comparable key)
Sets the row key for the domain crosshair and sends a {PlotChangeEvent} to all registered listeners.- Parameters:
key
- the key.
-
setDomainCrosshairRowKey
public void setDomainCrosshairRowKey(java.lang.Comparable key, boolean notify)
Sets the row key for the domain crosshair and, if requested, sends a {PlotChangeEvent} to all registered listeners.- Parameters:
key
- the key.notify
- notify listeners?
-
getDomainCrosshairColumnKey
public java.lang.Comparable getDomainCrosshairColumnKey()
Returns the column key for the domain crosshair.- Returns:
- The column key.
-
setDomainCrosshairColumnKey
public void setDomainCrosshairColumnKey(java.lang.Comparable key)
Sets the column key for the domain crosshair and sends aPlotChangeEvent
to all registered listeners.- Parameters:
key
- the key.
-
setDomainCrosshairColumnKey
public void setDomainCrosshairColumnKey(java.lang.Comparable key, boolean notify)
Sets the column key for the domain crosshair and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
key
- the key.notify
- notify listeners?
-
getCrosshairDatasetIndex
public int getCrosshairDatasetIndex()
Returns the dataset index for the crosshair.- Returns:
- The dataset index.
-
setCrosshairDatasetIndex
public void setCrosshairDatasetIndex(int index)
Sets the dataset index for the crosshair and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the index.
-
setCrosshairDatasetIndex
public void setCrosshairDatasetIndex(int index, boolean notify)
Sets the dataset index for the crosshair and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the index.notify
- notify listeners?
-
getDomainCrosshairPaint
public java.awt.Paint getDomainCrosshairPaint()
Returns the paint used to draw the domain crosshair.- Returns:
- The paint (never
null
). - See Also:
setDomainCrosshairPaint(Paint)
,getDomainCrosshairStroke()
-
setDomainCrosshairPaint
public void setDomainCrosshairPaint(java.awt.Paint paint)
Sets the paint used to draw the domain crosshair.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getDomainCrosshairPaint()
-
getDomainCrosshairStroke
public java.awt.Stroke getDomainCrosshairStroke()
Returns the stroke used to draw the domain crosshair.- Returns:
- The stroke (never
null
). - See Also:
setDomainCrosshairStroke(Stroke)
,getDomainCrosshairPaint()
-
setDomainCrosshairStroke
public void setDomainCrosshairStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the domain crosshair, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getDomainCrosshairStroke()
-
isRangeCrosshairVisible
public boolean isRangeCrosshairVisible()
Returns a flag indicating whether or not the range crosshair is visible.- Returns:
- The flag.
- See Also:
setRangeCrosshairVisible(boolean)
-
setRangeCrosshairVisible
public void setRangeCrosshairVisible(boolean flag)
Sets the flag indicating whether or not the range crosshair is visible.- Parameters:
flag
- the new value of the flag.- See Also:
isRangeCrosshairVisible()
-
isRangeCrosshairLockedOnData
public boolean isRangeCrosshairLockedOnData()
Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.- Returns:
- The flag.
- See Also:
setRangeCrosshairLockedOnData(boolean)
-
setRangeCrosshairLockedOnData
public void setRangeCrosshairLockedOnData(boolean flag)
Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values, and sends aPlotChangeEvent
to all registered listeners.- Parameters:
flag
- the flag.- See Also:
isRangeCrosshairLockedOnData()
-
getRangeCrosshairValue
public double getRangeCrosshairValue()
Returns the range crosshair value.- Returns:
- The value.
- See Also:
setRangeCrosshairValue(double)
-
setRangeCrosshairValue
public void setRangeCrosshairValue(double value)
Sets the range crosshair value and, if the crosshair is visible, sends aPlotChangeEvent
to all registered listeners.- Parameters:
value
- the new value.- See Also:
getRangeCrosshairValue()
-
setRangeCrosshairValue
public void setRangeCrosshairValue(double value, boolean notify)
Sets the range crosshair value and, if requested, sends aPlotChangeEvent
to all registered listeners (but only if the crosshair is visible).- Parameters:
value
- the new value.notify
- a flag that controls whether or not listeners are notified.- See Also:
getRangeCrosshairValue()
-
getRangeCrosshairStroke
public java.awt.Stroke getRangeCrosshairStroke()
Returns the pen-style (Stroke
) used to draw the crosshair (if visible).- Returns:
- The crosshair stroke (never
null
). - See Also:
setRangeCrosshairStroke(Stroke)
,isRangeCrosshairVisible()
,getRangeCrosshairPaint()
-
setRangeCrosshairStroke
public void setRangeCrosshairStroke(java.awt.Stroke stroke)
Sets the pen-style (Stroke
) used to draw the range crosshair (if visible), and sends aPlotChangeEvent
to all registered listeners.- Parameters:
stroke
- the new crosshair stroke (null
not permitted).- See Also:
getRangeCrosshairStroke()
-
getRangeCrosshairPaint
public java.awt.Paint getRangeCrosshairPaint()
Returns the paint used to draw the range crosshair.- Returns:
- The paint (never
null
). - See Also:
setRangeCrosshairPaint(Paint)
,isRangeCrosshairVisible()
,getRangeCrosshairStroke()
-
setRangeCrosshairPaint
public void setRangeCrosshairPaint(java.awt.Paint paint)
Sets the paint used to draw the range crosshair (if visible) and sends aPlotChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getRangeCrosshairPaint()
-
getAnnotations
public java.util.List getAnnotations()
Returns the list of annotations.- Returns:
- The list of annotations (never
null
). - See Also:
addAnnotation(CategoryAnnotation)
,clearAnnotations()
-
addAnnotation
public void addAnnotation(CategoryAnnotation annotation)
Adds an annotation to the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
annotation
- the annotation (null
not permitted).- See Also:
removeAnnotation(CategoryAnnotation)
-
addAnnotation
public void addAnnotation(CategoryAnnotation annotation, boolean notify)
Adds an annotation to the plot and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
annotation
- the annotation (null
not permitted).notify
- notify listeners?
-
removeAnnotation
public boolean removeAnnotation(CategoryAnnotation annotation)
Removes an annotation from the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
annotation
- the annotation (null
not permitted).- Returns:
- A boolean (indicates whether or not the annotation was removed).
- See Also:
addAnnotation(CategoryAnnotation)
-
removeAnnotation
public boolean removeAnnotation(CategoryAnnotation annotation, boolean notify)
Removes an annotation from the plot and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
annotation
- the annotation (null
not permitted).notify
- notify listeners?- Returns:
- A boolean (indicates whether or not the annotation was removed).
-
clearAnnotations
public void clearAnnotations()
Clears all the annotations and sends aPlotChangeEvent
to all registered listeners.
-
getShadowGenerator
public ShadowGenerator getShadowGenerator()
Returns the shadow generator for the plot, if any.- Returns:
- The shadow generator (possibly
null
).
-
setShadowGenerator
public void setShadowGenerator(ShadowGenerator generator)
Sets the shadow generator for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
calculateDomainAxisSpace
protected AxisSpace calculateDomainAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the domain axis/axes.- Parameters:
g2
- the graphics device.plotArea
- the plot area.space
- a carrier for the result (null
permitted).- Returns:
- The required space.
-
calculateRangeAxisSpace
protected AxisSpace calculateRangeAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the range axis/axes.- Parameters:
g2
- the graphics device.plotArea
- the plot area.space
- a carrier for the result (null
permitted).- Returns:
- The required space.
-
integerise
private java.awt.Rectangle integerise(java.awt.geom.Rectangle2D rect)
Trims a rectangle to integer coordinates.- Parameters:
rect
- the incoming rectangle.- Returns:
- A rectangle with integer coordinates.
-
calculateAxisSpace
protected AxisSpace calculateAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea)
Calculates the space required for the axes.- Parameters:
g2
- the graphics device.plotArea
- the plot area.- Returns:
- The space required for the axes.
-
draw
public void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area, java.awt.geom.Point2D anchor, PlotState parentState, PlotRenderingInfo state)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).At your option, you may supply an instance of
PlotRenderingInfo
. If you do, it will be populated with information about the drawing, including various plot dimensions and tooltip info.- Specified by:
draw
in classPlot
- Parameters:
g2
- the graphics device.area
- the area within which the plot (including axes) should be drawn.anchor
- the anchor point (null
permitted).parentState
- the state from the parent plot, if there is one.state
- collects info as the chart is drawn (possiblynull
).
-
getDatasetIndices
private java.util.List<java.lang.Integer> getDatasetIndices(DatasetRenderingOrder order)
Returns the indices of the non-null datasets in the specified order.- Parameters:
order
- the order (null
not permitted).- Returns:
- The list of indices.
-
getRendererIndices
private java.util.List<java.lang.Integer> getRendererIndices(DatasetRenderingOrder order)
Returns the indices of the non-null renderers for the plot, in the specified order.- Parameters:
order
- the rendering ordernull
not permitted).- Returns:
- A list of indices.
-
drawBackground
public void drawBackground(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
Draws the plot background (the background color and/or image).This method will be called during the chart drawing process and is declared public so that it can be accessed by the renderers used by certain subclasses. You shouldn't need to call this method directly.
- Overrides:
drawBackground
in classPlot
- Parameters:
g2
- the graphics device.area
- the area within which the plot should be drawn.
-
drawAxes
protected java.util.Map drawAxes(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, PlotRenderingInfo plotState)
A utility method for drawing the plot's axes.- Parameters:
g2
- the graphics device.plotArea
- the plot area.dataArea
- the data area.plotState
- collects information about the plot (null
permitted).- Returns:
- A map containing the axis states.
-
render
public boolean render(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, PlotRenderingInfo info, CategoryCrosshairState crosshairState)
Draws a representation of a dataset within the dataArea region using the appropriate renderer.- Parameters:
g2
- the graphics device.dataArea
- the region in which the data is to be drawn.index
- the dataset and renderer index.info
- an optional object for collection dimension information.crosshairState
- a state object for tracking crosshair info (null
permitted).- Returns:
- A boolean that indicates whether or not real data was found.
-
drawDomainGridlines
protected void drawDomainGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
Draws the domain gridlines for the plot, if they are visible.- Parameters:
g2
- the graphics device.dataArea
- the area inside the axes.- See Also:
drawRangeGridlines(Graphics2D, Rectangle2D, List)
-
drawRangeGridlines
protected void drawRangeGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, java.util.List ticks)
Draws the range gridlines for the plot, if they are visible.- Parameters:
g2
- the graphics device (null
not permitted).dataArea
- the area inside the axes (null
not permitted).ticks
- the ticks.- See Also:
drawDomainGridlines(Graphics2D, Rectangle2D)
-
drawZeroRangeBaseline
protected void drawZeroRangeBaseline(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
Draws a base line across the chart at value zero on the range axis.- Parameters:
g2
- the graphics device.area
- the data area.- See Also:
setRangeZeroBaselineVisible(boolean)
-
drawAnnotations
protected void drawAnnotations(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
Draws the annotations.- Parameters:
g2
- the graphics device.dataArea
- the data area.
-
drawDomainMarkers
protected void drawDomainMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, Layer layer)
Draws the domain markers (if any) for an axis and layer. This method is typically called from within the draw() method.- Parameters:
g2
- the graphics device.dataArea
- the data area.index
- the renderer index.layer
- the layer (foreground or background).- See Also:
drawRangeMarkers(Graphics2D, Rectangle2D, int, Layer)
-
drawRangeMarkers
protected void drawRangeMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, Layer layer)
Draws the range markers (if any) for an axis and layer. This method is typically called from within the draw() method.- Parameters:
g2
- the graphics device.dataArea
- the data area.index
- the renderer index.layer
- the layer (foreground or background).- See Also:
drawDomainMarkers(Graphics2D, Rectangle2D, int, Layer)
-
drawRangeLine
protected void drawRangeLine(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, double value, java.awt.Stroke stroke, java.awt.Paint paint)
Utility method for drawing a line perpendicular to the range axis (used for crosshairs).- Parameters:
g2
- the graphics device.dataArea
- the area defined by the axes.value
- the data value.stroke
- the line stroke (null
not permitted).paint
- the line paint (null
not permitted).
-
drawDomainCrosshair
protected void drawDomainCrosshair(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, PlotOrientation orientation, int datasetIndex, java.lang.Comparable rowKey, java.lang.Comparable columnKey, java.awt.Stroke stroke, java.awt.Paint paint)
Draws a domain crosshair.- Parameters:
g2
- the graphics target.dataArea
- the data area.orientation
- the plot orientation.datasetIndex
- the dataset index.rowKey
- the row key.columnKey
- the column key.stroke
- the stroke used to draw the crosshair line.paint
- the paint used to draw the crosshair line.- See Also:
drawRangeCrosshair(Graphics2D, Rectangle2D, PlotOrientation, double, ValueAxis, Stroke, Paint)
-
drawRangeCrosshair
protected void drawRangeCrosshair(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, java.awt.Stroke stroke, java.awt.Paint paint)
Draws a range crosshair.- Parameters:
g2
- the graphics target.dataArea
- the data area.orientation
- the plot orientation.value
- the crosshair value.axis
- the axis against which the value is measured.stroke
- the stroke used to draw the crosshair line.paint
- the paint used to draw the crosshair line.- See Also:
drawDomainCrosshair(Graphics2D, Rectangle2D, PlotOrientation, int, Comparable, Comparable, Stroke, Paint)
-
getDataRange
public Range getDataRange(ValueAxis axis)
Returns the range of data values that will be plotted against the range axis. If the dataset isnull
, this method returnsnull
.- Specified by:
getDataRange
in interfaceValueAxisPlot
- Parameters:
axis
- the axis.- Returns:
- The data range.
-
datasetsMappedToDomainAxis
private java.util.List<CategoryDataset> datasetsMappedToDomainAxis(int axisIndex)
Returns a list of the datasets that are mapped to the axis with the specified index.- Parameters:
axisIndex
- the axis index.- Returns:
- The list (possibly empty, but never
null
).
-
datasetsMappedToRangeAxis
private java.util.List<CategoryDataset> datasetsMappedToRangeAxis(int axisIndex)
A utility method that returns a list of datasets that are mapped to a given range axis.- Parameters:
axisIndex
- the axis index.- Returns:
- The list (possibly empty, but never
null
).
-
getWeight
public int getWeight()
Returns the weight for this plot when it is used as a subplot within a combined plot.- Returns:
- The weight.
- See Also:
setWeight(int)
-
setWeight
public void setWeight(int weight)
Sets the weight for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
weight
- the weight.- See Also:
getWeight()
-
getFixedDomainAxisSpace
public AxisSpace getFixedDomainAxisSpace()
Returns the fixed domain axis space.- Returns:
- The fixed domain axis space (possibly
null
). - See Also:
setFixedDomainAxisSpace(AxisSpace)
-
setFixedDomainAxisSpace
public void setFixedDomainAxisSpace(AxisSpace space)
Sets the fixed domain axis space and sends aPlotChangeEvent
to all registered listeners.- Parameters:
space
- the space (null
permitted).- See Also:
getFixedDomainAxisSpace()
-
setFixedDomainAxisSpace
public void setFixedDomainAxisSpace(AxisSpace space, boolean notify)
Sets the fixed domain axis space and sends aPlotChangeEvent
to all registered listeners.- Parameters:
space
- the space (null
permitted).notify
- notify listeners?- See Also:
getFixedDomainAxisSpace()
-
getFixedRangeAxisSpace
public AxisSpace getFixedRangeAxisSpace()
Returns the fixed range axis space.- Returns:
- The fixed range axis space (possibly
null
). - See Also:
setFixedRangeAxisSpace(AxisSpace)
-
setFixedRangeAxisSpace
public void setFixedRangeAxisSpace(AxisSpace space)
Sets the fixed range axis space and sends aPlotChangeEvent
to all registered listeners.- Parameters:
space
- the space (null
permitted).- See Also:
getFixedRangeAxisSpace()
-
setFixedRangeAxisSpace
public void setFixedRangeAxisSpace(AxisSpace space, boolean notify)
Sets the fixed range axis space and sends aPlotChangeEvent
to all registered listeners.- Parameters:
space
- the space (null
permitted).notify
- notify listeners?- See Also:
getFixedRangeAxisSpace()
-
getCategories
public java.util.List getCategories()
Returns a list of the categories in the plot's primary dataset.- Returns:
- A list of the categories in the plot's primary dataset.
- See Also:
getCategoriesForAxis(CategoryAxis)
-
getCategoriesForAxis
public java.util.List getCategoriesForAxis(CategoryAxis axis)
Returns a list of the categories that should be displayed for the specified axis.- Parameters:
axis
- the axis (null
not permitted)- Returns:
- The categories.
-
getDrawSharedDomainAxis
public boolean getDrawSharedDomainAxis()
Returns the flag that controls whether or not the shared domain axis is drawn for each subplot.- Returns:
- A boolean.
- See Also:
setDrawSharedDomainAxis(boolean)
-
setDrawSharedDomainAxis
public void setDrawSharedDomainAxis(boolean draw)
Sets the flag that controls whether the shared domain axis is drawn when this plot is being used as a subplot.- Parameters:
draw
- a boolean.- See Also:
getDrawSharedDomainAxis()
-
isDomainPannable
public boolean isDomainPannable()
Returnsfalse
always, because the plot cannot be panned along the domain axis/axes.- Specified by:
isDomainPannable
in interfacePannable
- Returns:
- A boolean.
- See Also:
isRangePannable()
-
isRangePannable
public boolean isRangePannable()
Returnstrue
if panning is enabled for the range axes, andfalse
otherwise.- Specified by:
isRangePannable
in interfacePannable
- Returns:
- A boolean.
- See Also:
setRangePannable(boolean)
,isDomainPannable()
-
setRangePannable
public void setRangePannable(boolean pannable)
Sets the flag that enables or disables panning of the plot along the range axes.- Parameters:
pannable
- the new flag value.- See Also:
isRangePannable()
-
panDomainAxes
public void panDomainAxes(double percent, PlotRenderingInfo info, java.awt.geom.Point2D source)
Pans the domain axes by the specified percentage.- Specified by:
panDomainAxes
in interfacePannable
- Parameters:
percent
- the distance to pan (as a percentage of the axis length).info
- the plot infosource
- the source point where the pan action started.
-
panRangeAxes
public void panRangeAxes(double percent, PlotRenderingInfo info, java.awt.geom.Point2D source)
Pans the range axes by the specified percentage.- Specified by:
panRangeAxes
in interfacePannable
- Parameters:
percent
- the distance to pan (as a percentage of the axis length).info
- the plot infosource
- the source point where the pan action started.
-
isDomainZoomable
public boolean isDomainZoomable()
Returnsfalse
to indicate that the domain axes are not zoomable.- Specified by:
isDomainZoomable
in interfaceZoomable
- Returns:
- A boolean.
- See Also:
isRangeZoomable()
-
isRangeZoomable
public boolean isRangeZoomable()
Returnstrue
to indicate that the range axes are zoomable.- Specified by:
isRangeZoomable
in interfaceZoomable
- Returns:
- A boolean.
- See Also:
isDomainZoomable()
-
zoomDomainAxes
public void zoomDomainAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.- Specified by:
zoomDomainAxes
in interfaceZoomable
- Parameters:
factor
- the zoom factor.state
- the plot state.source
- the source point (in Java2D space) for the zoom.- See Also:
Zoomable.zoomRangeAxes(double, PlotRenderingInfo, Point2D)
-
zoomDomainAxes
public void zoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.- Specified by:
zoomDomainAxes
in interfaceZoomable
- Parameters:
lowerPercent
- the lower bound.upperPercent
- the upper bound.state
- the plot state.source
- the source point (in Java2D space) for the zoom.- See Also:
Zoomable.zoomRangeAxes(double, double, PlotRenderingInfo, Point2D)
-
zoomDomainAxes
public void zoomDomainAxes(double factor, PlotRenderingInfo info, java.awt.geom.Point2D source, boolean useAnchor)
This method does nothing, becauseCategoryPlot
doesn't support zooming on the domain.- Specified by:
zoomDomainAxes
in interfaceZoomable
- Parameters:
factor
- the zoom factor.info
- the plot rendering info.source
- the source point (in Java2D space).useAnchor
- use source point as zoom anchor?- See Also:
zoomRangeAxes(double, PlotRenderingInfo, Point2D, boolean)
-
zoomRangeAxes
public void zoomRangeAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
Multiplies the range on the range axis/axes by the specified factor.- Specified by:
zoomRangeAxes
in interfaceZoomable
- Parameters:
factor
- the zoom factor.state
- the plot state.source
- the source point (in Java2D space) for the zoom.- See Also:
Zoomable.zoomDomainAxes(double, PlotRenderingInfo, Point2D)
-
zoomRangeAxes
public void zoomRangeAxes(double factor, PlotRenderingInfo info, java.awt.geom.Point2D source, boolean useAnchor)
Multiplies the range on the range axis/axes by the specified factor.- Specified by:
zoomRangeAxes
in interfaceZoomable
- Parameters:
factor
- the zoom factor.info
- the plot rendering info.source
- the source point.useAnchor
- a flag that controls whether or not the source point is used for the zoom anchor.- See Also:
zoomDomainAxes(double, PlotRenderingInfo, Point2D, boolean)
-
zoomRangeAxes
public void zoomRangeAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
Zooms in on the range axes.- Specified by:
zoomRangeAxes
in interfaceZoomable
- Parameters:
lowerPercent
- the lower bound.upperPercent
- the upper bound.state
- the plot state.source
- the source point (in Java2D space) for the zoom.- See Also:
Zoomable.zoomDomainAxes(double, double, PlotRenderingInfo, Point2D)
-
getAnchorValue
public double getAnchorValue()
Returns the anchor value.- Returns:
- The anchor value.
- See Also:
setAnchorValue(double)
-
setAnchorValue
public void setAnchorValue(double value)
Sets the anchor value and sends aPlotChangeEvent
to all registered listeners.- Parameters:
value
- the anchor value.- See Also:
getAnchorValue()
-
setAnchorValue
public void setAnchorValue(double value, boolean notify)
Sets the anchor value and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
value
- the value.notify
- notify listeners?- See Also:
getAnchorValue()
-
equals
public boolean equals(java.lang.Object obj)
Tests the plot for equality with an arbitrary object.
-
canEqual
public boolean canEqual(java.lang.Object other)
Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of the plot.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classPlot
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if the cloning is not supported.
-
cloneMarkerMap
private java.util.Map cloneMarkerMap(java.util.Map map) throws java.lang.CloneNotSupportedException
A utility method to clone the marker maps.- Parameters:
map
- the map to clone.- Returns:
- A clone of the map.
- Throws:
java.lang.CloneNotSupportedException
- if there is some problem cloning the map.
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
Provides serialization support.- Parameters:
stream
- the output stream.- Throws:
java.io.IOException
- if there is an I/O error.
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
Provides serialization support.- Parameters:
stream
- the input stream.- Throws:
java.io.IOException
- if there is an I/O error.java.lang.ClassNotFoundException
- if there is a classpath problem.
-
-