Interface CategoryItemRenderer
- All Superinterfaces:
LegendItemSource
- All Known Implementing Classes:
AbstractCategoryItemRenderer
,AreaRenderer
,BarRenderer
,BarRenderer3D
,BoxAndWhiskerRenderer
,CategoryStepRenderer
,DefaultCategoryItemRenderer
,GanttRenderer
,GroupedStackedBarRenderer
,IntervalBarRenderer
,LayeredBarRenderer
,LevelRenderer
,LineAndShapeRenderer
,LineRenderer3D
,MinMaxCategoryRenderer
,ScatterRenderer
,StackedAreaRenderer
,StackedBarRenderer
,StackedBarRenderer3D
,StatisticalBarRenderer
,StatisticalLineAndShapeRenderer
,WaterfallBarRenderer
CategoryPlot
class to display
individual data items from a CategoryDataset
.
This interface defines the methods that must be provided by all renderers.
If you are implementing a custom renderer, you should consider extending the
AbstractCategoryItemRenderer
class.
Most renderer attributes are defined using a "three layer" approach. When
looking up an attribute (for example, the outline paint) the renderer first
checks to see if there is a setting (in layer 0) that applies to ALL items
that the renderer draws. If there is, that setting is used, but if it is
null
the renderer looks up the next layer, which contains
"per series" settings for the attribute (many attributes are defined on a
per series basis, so this is the layer that is most commonly used). If the
layer 1 setting is null
, the renderer will look up the final
layer, which provides a default or "base" setting. Some attributes allow
the base setting to be null
, while other attributes enforce
non-null
values.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addChangeListener
(RendererChangeListener listener) Adds a change listener.void
drawBackground
(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea) Draws a background for the data area.void
drawDomainGridline
(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value) Draws a grid line against the domain axis.void
drawDomainMarker
(Graphics2D g2, CategoryPlot plot, CategoryAxis axis, CategoryMarker marker, Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular category on the domain axis.void
drawItem
(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass) Draws a single data item.void
drawOutline
(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea) Draws an outline for the data area.void
drawRangeGridline
(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value) Draws a grid line against the range axis.void
drawRangeMarker
(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular value on the range axis.findRangeBounds
(CategoryDataset dataset) Returns the range of values the renderer requires to display all the items from the specified dataset.Returns the base item label font (this is used when no other font setting is available).Returns the base item label generator.Returns the base item label paint.Returns the base setting for item label visibility.Returns the base item URL generator.Returns the base item label position for negative values.Returns the base outline paint.Returns the base outline stroke.Returns the base paint.Returns the base positive item label position.boolean
Returns the base visibility for all series.boolean
Returns the base visibility in the legend for all series.Returns the base shape.Returns the base stroke.Returns the base tool tip generator (the "layer 2" generator).Deprecated.This method should no longer be used (as of version 1.0.6).getItemLabelFont
(int row, int column) Returns the font for an item label.getItemLabelGenerator
(int series, int item) Returns the item label generator for the specified data item.Deprecated.This method should no longer be used (as of version 1.0.6).getItemLabelPaint
(int row, int column) Returns the paint used to draw an item label.double
getItemMiddle
(Comparable rowKey, Comparable columnKey, CategoryDataset dataset, CategoryAxis axis, Rectangle2D area, org.jfree.ui.RectangleEdge edge) Returns the Java2D coordinate for the middle of the specified data item.getItemOutlinePaint
(int row, int column) Returns the paint used to outline data items as they are drawn.getItemOutlineStroke
(int row, int column) Returns the stroke used to outline data items.getItemPaint
(int row, int column) Returns the paint used to fill data items as they are drawn.getItemShape
(int row, int column) Returns a shape used to represent a data item.getItemStroke
(int row, int column) Returns the stroke used to draw data items.getItemURLGenerator
(int series, int item) Returns the URL generator for an item.boolean
getItemVisible
(int series, int item) Returns a boolean that indicates whether or not the specified item should be drawn (this is typically used to hide an entire series).getLegendItem
(int datasetIndex, int series) Returns a legend item for a series.Deprecated.This method should no longer be used (as of version 1.0.6).getNegativeItemLabelPosition
(int row, int column) Returns the item label position for negative values.int
Returns the number of passes through the dataset required by the renderer.getPlot()
Returns the plot that the renderer has been assigned to (wherenull
indicates that the renderer is not currently assigned to a plot).Deprecated.This method should no longer be used (as of version 1.0.6).getPositiveItemLabelPosition
(int row, int column) Returns the item label position for positive values.getSeriesItemLabelFont
(int series) Returns the font for all the item labels in a series.getSeriesItemLabelGenerator
(int series) Returns the item label generator for a series.getSeriesItemLabelPaint
(int series) Returns the paint used to draw the item labels for a series.getSeriesItemURLGenerator
(int series) Returns the item URL generator for a series.getSeriesNegativeItemLabelPosition
(int series) Returns the item label position for all negative values in a series.getSeriesOutlinePaint
(int series) Returns the paint used to outline an item drawn by the renderer.getSeriesOutlineStroke
(int series) Returns the stroke used to outline the items in a series.getSeriesPaint
(int series) Returns the paint used to fill an item drawn by the renderer.getSeriesPositiveItemLabelPosition
(int series) Returns the item label position for all positive values in a series.getSeriesShape
(int series) Returns a shape used to represent the items in a series.getSeriesStroke
(int series) Returns the stroke used to draw the items in a series.getSeriesToolTipGenerator
(int series) Returns the tool tip generator for the specified series (a "layer 1" generator).Deprecated.This method should no longer be used (as of version 1.0.6).getSeriesVisible
(int series) Returns the flag that controls whether a series is visible.Deprecated.This method should no longer be used (as of version 1.0.6).getSeriesVisibleInLegend
(int series) Returns the flag that controls whether a series is visible in the legend.Deprecated.This method should no longer be used (as of version 1.0.6).getToolTipGenerator
(int row, int column) Returns the tool tip generator that should be used for the specified item.initialise
(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info) Initialises the renderer.boolean
isItemLabelVisible
(int row, int column) Returnstrue
if an item label is visible, andfalse
otherwise.boolean
isSeriesItemLabelsVisible
(int series) Returnstrue
if the item labels for a series are visible, andfalse
otherwise.boolean
isSeriesVisible
(int series) Returns a boolean that indicates whether or not the specified series should be drawn (this is typically used to hide an entire series).boolean
isSeriesVisibleInLegend
(int series) Returnstrue
if the series should be shown in the legend, andfalse
otherwise.void
removeChangeListener
(RendererChangeListener listener) Removes a change listener.void
setBaseItemLabelFont
(Font font) Sets the base item label font and sends aRendererChangeEvent
to all registered listeners.void
Sets the base item label generator and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelPaint
(Paint paint) Sets the base item label paint and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelsVisible
(boolean visible) Sets the base flag that controls whether or not item labels are visible and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelsVisible
(Boolean visible) Sets the base setting for item label visibility and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelsVisible
(Boolean visible, boolean notify) Sets the base visibility for item labels and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseItemURLGenerator
(CategoryURLGenerator generator) Sets the base item URL generator and sends aRendererChangeEvent
to all registered listeners.void
Sets the base item label position for negative values and sends aRendererChangeEvent
to all registered listeners.void
setBaseNegativeItemLabelPosition
(ItemLabelPosition position, boolean notify) Sets the base negative item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseOutlinePaint
(Paint paint) Sets the base outline paint and sends aRendererChangeEvent
to all registered listeners.void
setBaseOutlineStroke
(Stroke stroke) Sets the base outline stroke and sends aRendererChangeEvent
to all registered listeners.void
setBasePaint
(Paint paint) Sets the base paint and sends aRendererChangeEvent
to all registered listeners.void
Sets the base positive item label position.void
setBasePositiveItemLabelPosition
(ItemLabelPosition position, boolean notify) Sets the base positive item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseSeriesVisible
(boolean visible) Sets the base visibility and sends aRendererChangeEvent
to all registered listeners.void
setBaseSeriesVisible
(boolean visible, boolean notify) Sets the base visibility and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseSeriesVisibleInLegend
(boolean visible) Sets the base visibility in the legend and sends aRendererChangeEvent
to all registered listeners.void
setBaseSeriesVisibleInLegend
(boolean visible, boolean notify) Sets the base visibility in the legend and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseShape
(Shape shape) Sets the base shape and sends aRendererChangeEvent
to all registered listeners.void
setBaseStroke
(Stroke stroke) Sets the base stroke and sends aRendererChangeEvent
to all registered listeners.void
setBaseToolTipGenerator
(CategoryToolTipGenerator generator) Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelFont
(Font font) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemLabelGenerator
(CategoryItemLabelGenerator generator) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemLabelPaint
(Paint paint) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemLabelsVisible
(boolean visible) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemLabelsVisible
(Boolean visible) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemLabelsVisible
(Boolean visible, boolean notify) Deprecated.This method should no longer be used (as of version 1.0.6).void
setItemURLGenerator
(CategoryURLGenerator generator) Deprecated.This method should no longer be used (as of version 1.0.6).void
Deprecated.This method should no longer be used (as of version 1.0.6).void
setNegativeItemLabelPosition
(ItemLabelPosition position, boolean notify) Deprecated.This method should no longer be used (as of version 1.0.6).void
setOutlinePaint
(Paint paint) Deprecated.This method should no longer be used (as of version 1.0.6).void
setOutlineStroke
(Stroke stroke) Deprecated.This method should no longer be used (as of version 1.0.6).void
Deprecated.This method should no longer be used (as of version 1.0.6).void
setPlot
(CategoryPlot plot) Sets the plot that the renderer has been assigned to.void
Deprecated.This method should no longer be used (as of version 1.0.6).void
setPositiveItemLabelPosition
(ItemLabelPosition position, boolean notify) Deprecated.This method should no longer be used (as of version 1.0.6).void
setSeriesItemLabelFont
(int series, Font font) Sets the item label font for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelGenerator
(int series, CategoryItemLabelGenerator generator) Sets the item label generator for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelPaint
(int series, Paint paint) Sets the item label paint for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelsVisible
(int series, boolean visible) Sets a flag that controls the visibility of the item labels for a series.void
setSeriesItemLabelsVisible
(int series, Boolean visible) Sets a flag that controls the visibility of the item labels for a series.void
setSeriesItemLabelsVisible
(int series, Boolean visible, boolean notify) Sets the visibility of item labels for a series and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemURLGenerator
(int series, CategoryURLGenerator generator) Sets the item URL generator for a series.void
setSeriesNegativeItemLabelPosition
(int series, ItemLabelPosition position) Sets the item label position for negative values in a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesNegativeItemLabelPosition
(int series, ItemLabelPosition position, boolean notify) Sets the item label position for negative values in a series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setSeriesOutlinePaint
(int series, Paint paint) Sets the paint used for a series outline and sends aRendererChangeEvent
to all registered listeners.void
setSeriesOutlineStroke
(int series, Stroke stroke) Sets the outline stroke used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesPaint
(int series, Paint paint) Sets the paint used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesPositiveItemLabelPosition
(int series, ItemLabelPosition position) Sets the item label position for all positive values in a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesPositiveItemLabelPosition
(int series, ItemLabelPosition position, boolean notify) Sets the item label position for all positive values in a series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setSeriesShape
(int series, Shape shape) Sets the shape used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesStroke
(int series, Stroke stroke) Sets the stroke used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesToolTipGenerator
(int series, CategoryToolTipGenerator generator) Sets the tool tip generator for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesVisible
(int series, Boolean visible) Sets the flag that controls whether a series is visible and sends aRendererChangeEvent
to all registered listeners.void
setSeriesVisible
(int series, Boolean visible, boolean notify) Sets the flag that controls whether a series is visible and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setSeriesVisible
(Boolean visible) Deprecated.This method should no longer be used (as of version 1.0.6).void
setSeriesVisible
(Boolean visible, boolean notify) Deprecated.This method should no longer be used (as of version 1.0.6).void
setSeriesVisibleInLegend
(int series, Boolean visible) Sets the flag that controls whether a series is visible in the legend and sends aRendererChangeEvent
to all registered listeners.void
setSeriesVisibleInLegend
(int series, Boolean visible, boolean notify) Sets the flag that controls whether a series is visible in the legend and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setSeriesVisibleInLegend
(Boolean visible) Deprecated.This method should no longer be used (as of version 1.0.6).void
setSeriesVisibleInLegend
(Boolean visible, boolean notify) Deprecated.This method should no longer be used (as of version 1.0.6).void
Deprecated.This method should no longer be used (as of version 1.0.6).void
Deprecated.This method should no longer be used (as of version 1.0.6).void
setToolTipGenerator
(CategoryToolTipGenerator generator) Deprecated.This method should no longer be used (as of version 1.0.6).Methods inherited from interface org.jfree.chart.LegendItemSource
getLegendItems
-
Method Details
-
getPassCount
int getPassCount()Returns the number of passes through the dataset required by the renderer. Usually this will be one, but some renderers may use a second or third pass to overlay items on top of things that were drawn in an earlier pass.- Returns:
- The pass count.
-
getPlot
CategoryPlot getPlot()Returns the plot that the renderer has been assigned to (wherenull
indicates that the renderer is not currently assigned to a plot).- Returns:
- The plot (possibly
null
). - See Also:
-
setPlot
Sets the plot that the renderer has been assigned to. This method is usually called by theCategoryPlot
, in normal usage you shouldn't need to call this method directly.- Parameters:
plot
- the plot (null
not permitted).- See Also:
-
addChangeListener
Adds a change listener.- Parameters:
listener
- the listener.- See Also:
-
removeChangeListener
Removes a change listener.- Parameters:
listener
- the listener.- See Also:
-
findRangeBounds
Returns the range of values the renderer requires to display all the items from the specified dataset.- Parameters:
dataset
- the dataset (null
permitted).- Returns:
- The range (or
null
if the dataset isnull
or empty).
-
initialise
CategoryItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info) Initialises the renderer. This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.- Parameters:
g2
- the graphics device.dataArea
- the area inside the axes.plot
- the plot.rendererIndex
- the renderer index.info
- collects chart rendering information for return to caller.- Returns:
- A state object (maintains state information relevant to one chart drawing).
-
getItemVisible
boolean getItemVisible(int series, int item) Returns a boolean that indicates whether or not the specified item should be drawn (this is typically used to hide an entire series).- Parameters:
series
- the series index.item
- the item index.- Returns:
- A boolean.
-
isSeriesVisible
boolean isSeriesVisible(int series) Returns a boolean that indicates whether or not the specified series should be drawn (this is typically used to hide an entire series).- Parameters:
series
- the series index.- Returns:
- A boolean.
-
getSeriesVisible
Boolean getSeriesVisible()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesVisible(int)
andgetBaseSeriesVisible()
.Returns the flag that controls the visibility of ALL series. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Returns:
- The flag (possibly
null
). - See Also:
-
setSeriesVisible
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesVisible(int, Boolean)
andsetBaseSeriesVisible(boolean)
.Sets the flag that controls the visibility of ALL series and sends aRendererChangeEvent
to all registered listeners. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Parameters:
visible
- the flag (null
permitted).- See Also:
-
setSeriesVisible
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesVisible(int, Boolean, boolean)
andsetBaseSeriesVisible(boolean, boolean)
.Sets the flag that controls the visibility of ALL series and sends aRendererChangeEvent
to all registered listeners. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Parameters:
visible
- the flag (null
permitted).notify
- notify listeners?- See Also:
-
getSeriesVisible
Returns the flag that controls whether a series is visible.- Parameters:
series
- the series index (zero-based).- Returns:
- The flag (possibly
null
). - See Also:
-
setSeriesVisible
Sets the flag that controls whether a series is visible and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).visible
- the flag (null
permitted).- See Also:
-
setSeriesVisible
Sets the flag that controls whether a series is visible and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index.visible
- the flag (null
permitted).notify
- notify listeners?- See Also:
-
getBaseSeriesVisible
boolean getBaseSeriesVisible()Returns the base visibility for all series.- Returns:
- The base visibility.
- See Also:
-
setBaseSeriesVisible
void setBaseSeriesVisible(boolean visible) Sets the base visibility and sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the flag.- See Also:
-
setBaseSeriesVisible
void setBaseSeriesVisible(boolean visible, boolean notify) Sets the base visibility and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the visibility.notify
- notify listeners?- See Also:
-
isSeriesVisibleInLegend
boolean isSeriesVisibleInLegend(int series) Returnstrue
if the series should be shown in the legend, andfalse
otherwise.- Parameters:
series
- the series index.- Returns:
- A boolean.
-
getSeriesVisibleInLegend
Boolean getSeriesVisibleInLegend()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesVisibleInLegend(int)
andgetBaseSeriesVisibleInLegend()
.Returns the flag that controls the visibility of ALL series in the legend. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Returns:
- The flag (possibly
null
). - See Also:
-
setSeriesVisibleInLegend
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesVisibleInLegend(int, Boolean)
andsetBaseSeriesVisibleInLegend(boolean)
.Sets the flag that controls the visibility of ALL series in the legend and sends aRendererChangeEvent
to all registered listeners. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Parameters:
visible
- the flag (null
permitted).- See Also:
-
setSeriesVisibleInLegend
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesVisibleInLegend(int, Boolean, boolean)
andsetBaseSeriesVisibleInLegend(boolean, boolean)
.Sets the flag that controls the visibility of ALL series in the legend and sends aRendererChangeEvent
to all registered listeners. This flag overrides the per series and default settings - you must set it tonull
if you want the other settings to apply.- Parameters:
visible
- the flag (null
permitted).notify
- notify listeners?- See Also:
-
getSeriesVisibleInLegend
Returns the flag that controls whether a series is visible in the legend. This method returns only the "per series" settings - to incorporate the override and base settings as well, you need to use theisSeriesVisibleInLegend(int)
method.- Parameters:
series
- the series index (zero-based).- Returns:
- The flag (possibly
null
). - See Also:
-
setSeriesVisibleInLegend
Sets the flag that controls whether a series is visible in the legend and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).visible
- the flag (null
permitted).- See Also:
-
setSeriesVisibleInLegend
Sets the flag that controls whether a series is visible in the legend and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index.visible
- the flag (null
permitted).notify
- notify listeners?- See Also:
-
getBaseSeriesVisibleInLegend
boolean getBaseSeriesVisibleInLegend()Returns the base visibility in the legend for all series.- Returns:
- The base visibility.
- See Also:
-
setBaseSeriesVisibleInLegend
void setBaseSeriesVisibleInLegend(boolean visible) Sets the base visibility in the legend and sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the flag.- See Also:
-
setBaseSeriesVisibleInLegend
void setBaseSeriesVisibleInLegend(boolean visible, boolean notify) Sets the base visibility in the legend and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the visibility.notify
- notify listeners?- See Also:
-
getItemPaint
Returns the paint used to fill data items as they are drawn.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- The paint (never
null
).
-
setPaint
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesPaint(int, Paint)
andsetBasePaint(Paint)
.Sets the paint to be used for ALL series, and sends aRendererChangeEvent
to all registered listeners. If this isnull
, the renderer will use the paint for the series.- Parameters:
paint
- the paint (null
permitted).
-
getSeriesPaint
Returns the paint used to fill an item drawn by the renderer.- Parameters:
series
- the series index (zero-based).- Returns:
- The paint (possibly
null
). - See Also:
-
setSeriesPaint
Sets the paint used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).paint
- the paint (null
permitted).- See Also:
-
getBasePaint
Paint getBasePaint()Returns the base paint.- Returns:
- The base paint (never
null
). - See Also:
-
setBasePaint
Sets the base paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
-
getItemOutlinePaint
Returns the paint used to outline data items as they are drawn.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- The paint (never
null
).
-
setOutlinePaint
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesOutlinePaint(int, Paint)
andsetBaseOutlinePaint(Paint)
.Sets the outline paint for ALL series (optional).- Parameters:
paint
- the paint (null
permitted).
-
getSeriesOutlinePaint
Returns the paint used to outline an item drawn by the renderer.- Parameters:
series
- the series (zero-based index).- Returns:
- The paint (possibly
null
). - See Also:
-
setSeriesOutlinePaint
Sets the paint used for a series outline and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).paint
- the paint (null
permitted).- See Also:
-
getBaseOutlinePaint
Paint getBaseOutlinePaint()Returns the base outline paint.- Returns:
- The paint (never
null
). - See Also:
-
setBaseOutlinePaint
Sets the base outline paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
-
getItemStroke
Returns the stroke used to draw data items.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- The stroke (never
null
).
-
setStroke
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesStroke(int, Stroke)
andsetBaseStroke(Stroke)
.Sets the stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
permitted).
-
getSeriesStroke
Returns the stroke used to draw the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- The stroke (never
null
). - See Also:
-
setSeriesStroke
Sets the stroke used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).stroke
- the stroke (null
permitted).- See Also:
-
getBaseStroke
Stroke getBaseStroke()Returns the base stroke.- Returns:
- The base stroke (never
null
). - See Also:
-
setBaseStroke
Sets the base stroke and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
-
getItemOutlineStroke
Returns the stroke used to outline data items.The default implementation passes control to the lookupSeriesOutlineStroke method. You can override this method if you require different behaviour.
- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- The stroke (never
null
).
-
setOutlineStroke
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesOutlineStroke(int, Stroke)
andsetBaseOutlineStroke(Stroke)
.Sets the outline stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
permitted).
-
getSeriesOutlineStroke
Returns the stroke used to outline the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- The stroke (possibly
null
). - See Also:
-
setSeriesOutlineStroke
Sets the outline stroke used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).stroke
- the stroke (null
permitted).- See Also:
-
getBaseOutlineStroke
Stroke getBaseOutlineStroke()Returns the base outline stroke.- Returns:
- The stroke (never
null
). - See Also:
-
setBaseOutlineStroke
Sets the base outline stroke and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
-
getItemShape
Returns a shape used to represent a data item.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- The shape (never
null
).
-
setShape
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesShape(int, Shape)
andsetBaseShape(Shape)
.Sets the shape for ALL series (optional) and sends aRendererChangeEvent
to all registered listeners.- Parameters:
shape
- the shape (null
permitted).
-
getSeriesShape
Returns a shape used to represent the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- The shape (possibly
null
). - See Also:
-
setSeriesShape
Sets the shape used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).shape
- the shape (null
permitted).- See Also:
-
getBaseShape
Shape getBaseShape()Returns the base shape.- Returns:
- The shape (never
null
). - See Also:
-
setBaseShape
Sets the base shape and sends aRendererChangeEvent
to all registered listeners.- Parameters:
shape
- the shape (null
not permitted).- See Also:
-
isItemLabelVisible
boolean isItemLabelVisible(int row, int column) Returnstrue
if an item label is visible, andfalse
otherwise.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- A boolean.
-
setItemLabelsVisible
void setItemLabelsVisible(boolean visible) Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelsVisible(int, Boolean)
andsetBaseItemLabelsVisible(boolean)
.Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag.- See Also:
-
setItemLabelsVisible
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelsVisible(int, Boolean)
andsetBaseItemLabelsVisible(boolean)
.Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag (null
permitted).- See Also:
-
setItemLabelsVisible
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelsVisible(int, Boolean, boolean)
andsetBaseItemLabelsVisible(Boolean, boolean)
.Sets the visibility of item labels for ALL series and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- a flag that controls whether or not the item labels are visible (null
permitted).notify
- a flag that controls whether or not listeners are notified.
-
isSeriesItemLabelsVisible
boolean isSeriesItemLabelsVisible(int series) Returnstrue
if the item labels for a series are visible, andfalse
otherwise.- Parameters:
series
- the series index (zero-based).- Returns:
- A boolean.
- See Also:
-
setSeriesItemLabelsVisible
void setSeriesItemLabelsVisible(int series, boolean visible) Sets a flag that controls the visibility of the item labels for a series.- Parameters:
series
- the series index (zero-based).visible
- the flag.- See Also:
-
setSeriesItemLabelsVisible
Sets a flag that controls the visibility of the item labels for a series.- Parameters:
series
- the series index (zero-based).visible
- the flag (null
permitted).- See Also:
-
setSeriesItemLabelsVisible
Sets the visibility of item labels for a series and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).visible
- the visible flag.notify
- a flag that controls whether or not listeners are notified.- See Also:
-
getBaseItemLabelsVisible
Boolean getBaseItemLabelsVisible()Returns the base setting for item label visibility. Anull
result should be interpreted as equivalent toBoolean.FALSE
(this is an error in the API design, the return value should have been a boolean primitive).- Returns:
- A flag (possibly
null
). - See Also:
-
setBaseItemLabelsVisible
void setBaseItemLabelsVisible(boolean visible) Sets the base flag that controls whether or not item labels are visible and sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the flag.- See Also:
-
setBaseItemLabelsVisible
Sets the base setting for item label visibility and sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the flag (null
permitted).- See Also:
-
setBaseItemLabelsVisible
Sets the base visibility for item labels and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the visibility flag.notify
- a flag that controls whether or not listeners are notified.- See Also:
-
getItemLabelGenerator
Returns the item label generator for the specified data item.- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The generator (possibly
null
).
-
setItemLabelGenerator
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelGenerator(int, CategoryItemLabelGenerator)
andsetBaseItemLabelGenerator(CategoryItemLabelGenerator)
.Sets the item label generator for ALL series and sends aRendererChangeEvent
to all registered listeners. This overrides the per-series settings.- Parameters:
generator
- the generator (null
permitted).
-
getSeriesItemLabelGenerator
Returns the item label generator for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The label generator (possibly
null
). - See Also:
-
setSeriesItemLabelGenerator
Sets the item label generator for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).generator
- the generator.- See Also:
-
getBaseItemLabelGenerator
CategoryItemLabelGenerator getBaseItemLabelGenerator()Returns the base item label generator.- Returns:
- The generator (possibly
null
). - See Also:
-
setBaseItemLabelGenerator
Sets the base item label generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).- See Also:
-
getToolTipGenerator
Returns the tool tip generator that should be used for the specified item. This method looks up the generator using the "three-layer" approach outlined in the general description of this interface.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- The generator (possibly
null
).
-
getToolTipGenerator
CategoryToolTipGenerator getToolTipGenerator()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesToolTipGenerator(int)
andgetBaseToolTipGenerator()
.Returns the tool tip generator that will be used for ALL items in the dataset (the "layer 0" generator).- Returns:
- A tool tip generator (possibly
null
). - See Also:
-
setToolTipGenerator
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesToolTipGenerator(int, CategoryToolTipGenerator)
andsetBaseToolTipGenerator(CategoryToolTipGenerator)
.Sets the tool tip generator for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).- See Also:
-
getSeriesToolTipGenerator
Returns the tool tip generator for the specified series (a "layer 1" generator).- Parameters:
series
- the series index (zero-based).- Returns:
- The tool tip generator (possibly
null
). - See Also:
-
setSeriesToolTipGenerator
Sets the tool tip generator for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).generator
- the generator (null
permitted).- See Also:
-
getBaseToolTipGenerator
CategoryToolTipGenerator getBaseToolTipGenerator()Returns the base tool tip generator (the "layer 2" generator).- Returns:
- The tool tip generator (possibly
null
). - See Also:
-
setBaseToolTipGenerator
Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).- See Also:
-
getItemLabelFont
Returns the font for an item label.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- The font (never
null
).
-
getItemLabelFont
Font getItemLabelFont()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesItemLabelFont(int)
andgetBaseItemLabelFont()
.Returns the font used for all item labels. This may benull
, in which case the per series font settings will apply.- Returns:
- The font (possibly
null
). - See Also:
-
setItemLabelFont
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelFont(int, Font)
andsetBaseItemLabelFont(Font)
.Sets the item label font for ALL series and sends aRendererChangeEvent
to all registered listeners. You can set this tonull
if you prefer to set the font on a per series basis.- Parameters:
font
- the font (null
permitted).- See Also:
-
getSeriesItemLabelFont
Returns the font for all the item labels in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The font (possibly
null
). - See Also:
-
setSeriesItemLabelFont
Sets the item label font for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).font
- the font (null
permitted).- See Also:
-
getBaseItemLabelFont
Font getBaseItemLabelFont()Returns the base item label font (this is used when no other font setting is available).- Returns:
- The font (
never
null). - See Also:
-
setBaseItemLabelFont
Sets the base item label font and sends aRendererChangeEvent
to all registered listeners.- Parameters:
font
- the font (null
not permitted).- See Also:
-
getItemLabelPaint
Returns the paint used to draw an item label.- Parameters:
row
- the row index (zero based).column
- the column index (zero based).- Returns:
- The paint (never
null
).
-
getItemLabelPaint
Paint getItemLabelPaint()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesItemLabelPaint(int)
andgetBaseItemLabelPaint()
.Returns the paint used for all item labels. This may benull
, in which case the per series paint settings will apply.- Returns:
- The paint (possibly
null
). - See Also:
-
setItemLabelPaint
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemLabelPaint(int, Paint)
andsetBaseItemLabelPaint(Paint)
.Sets the item label paint for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
permitted).- See Also:
-
getSeriesItemLabelPaint
Returns the paint used to draw the item labels for a series.- Parameters:
series
- the series index (zero based).- Returns:
- The paint (possibly
null
). - See Also:
-
setSeriesItemLabelPaint
Sets the item label paint for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series (zero based index).paint
- the paint (null
permitted).- See Also:
-
getBaseItemLabelPaint
Paint getBaseItemLabelPaint()Returns the base item label paint.- Returns:
- The paint (never
null
). - See Also:
-
setBaseItemLabelPaint
Sets the base item label paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
-
getPositiveItemLabelPosition
Returns the item label position for positive values.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- The item label position (never
null
).
-
getPositiveItemLabelPosition
ItemLabelPosition getPositiveItemLabelPosition()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesPositiveItemLabelPosition(int)
andgetBasePositiveItemLabelPosition()
.Returns the item label position for positive values in ALL series.- Returns:
- The item label position (possibly
null
). - See Also:
-
setPositiveItemLabelPosition
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesPositiveItemLabelPosition(int, ItemLabelPosition)
andsetBasePositiveItemLabelPosition(ItemLabelPosition)
.Sets the item label position for positive values in ALL series, and sends aRendererChangeEvent
to all registered listeners. You need to set this tonull
to expose the settings for individual series.- Parameters:
position
- the position (null
permitted).- See Also:
-
setPositiveItemLabelPosition
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesPositiveItemLabelPosition(int, ItemLabelPosition, boolean)
andsetBasePositiveItemLabelPosition(ItemLabelPosition, boolean)
.Sets the positive item label position for ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
permitted).notify
- notify registered listeners?- See Also:
-
getSeriesPositiveItemLabelPosition
Returns the item label position for all positive values in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The item label position.
- See Also:
-
setSeriesPositiveItemLabelPosition
Sets the item label position for all positive values in a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).- See Also:
-
setSeriesPositiveItemLabelPosition
Sets the item label position for all positive values in a series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?- See Also:
-
getBasePositiveItemLabelPosition
ItemLabelPosition getBasePositiveItemLabelPosition()Returns the base positive item label position.- Returns:
- The position.
- See Also:
-
setBasePositiveItemLabelPosition
Sets the base positive item label position.- Parameters:
position
- the position.- See Also:
-
setBasePositiveItemLabelPosition
Sets the base positive item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position.notify
- notify registered listeners?- See Also:
-
getNegativeItemLabelPosition
Returns the item label position for negative values. This method can be overridden to provide customisation of the item label position for individual data items.- Parameters:
row
- the row index (zero-based).column
- the column (zero-based).- Returns:
- The item label position.
-
getNegativeItemLabelPosition
ItemLabelPosition getNegativeItemLabelPosition()Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely ongetSeriesNegativeItemLabelPosition(int)
andgetBaseNegativeItemLabelPosition()
.Returns the item label position for negative values in ALL series.- Returns:
- The item label position (possibly
null
). - See Also:
-
setNegativeItemLabelPosition
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesNegativeItemLabelPosition(int, ItemLabelPosition)
andsetBaseNegativeItemLabelPosition(ItemLabelPosition)
.Sets the item label position for negative values in ALL series, and sends aRendererChangeEvent
to all registered listeners. You need to set this tonull
to expose the settings for individual series.- Parameters:
position
- the position (null
permitted).- See Also:
-
setNegativeItemLabelPosition
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesNegativeItemLabelPosition(int, ItemLabelPosition, boolean)
andsetBaseNegativeItemLabelPosition(ItemLabelPosition, boolean)
.Sets the item label position for negative values in ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
permitted).notify
- notify registered listeners?- See Also:
-
getSeriesNegativeItemLabelPosition
Returns the item label position for all negative values in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The item label position.
- See Also:
-
setSeriesNegativeItemLabelPosition
Sets the item label position for negative values in a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).- See Also:
-
setSeriesNegativeItemLabelPosition
Sets the item label position for negative values in a series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?- See Also:
-
getBaseNegativeItemLabelPosition
ItemLabelPosition getBaseNegativeItemLabelPosition()Returns the base item label position for negative values.- Returns:
- The position.
- See Also:
-
setBaseNegativeItemLabelPosition
Sets the base item label position for negative values and sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position.- See Also:
-
setBaseNegativeItemLabelPosition
Sets the base negative item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position.notify
- notify registered listeners?- See Also:
-
getItemURLGenerator
Returns the URL generator for an item.- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The item URL generator.
-
setItemURLGenerator
Deprecated.This method should no longer be used (as of version 1.0.6). It is sufficient to rely onsetSeriesItemURLGenerator(int, CategoryURLGenerator)
andsetBaseItemURLGenerator(CategoryURLGenerator)
.Sets the item URL generator for ALL series.- Parameters:
generator
- the generator.- See Also:
-
getSeriesItemURLGenerator
Returns the item URL generator for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The URL generator.
- See Also:
-
setSeriesItemURLGenerator
Sets the item URL generator for a series.- Parameters:
series
- the series index (zero-based).generator
- the generator.- See Also:
-
getBaseItemURLGenerator
CategoryURLGenerator getBaseItemURLGenerator()Returns the base item URL generator.- Returns:
- The item URL generator (possibly
null
). - See Also:
-
setBaseItemURLGenerator
Sets the base item URL generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the item URL generator (null
permitted).- See Also:
-
getLegendItem
Returns a legend item for a series. This method can returnnull
, in which case the series will have no entry in the legend.- Parameters:
datasetIndex
- the dataset index (zero-based).series
- the series (zero-based index).- Returns:
- The legend item (possibly
null
).
-
drawBackground
Draws a background for the data area.- Parameters:
g2
- the graphics device.plot
- the plot.dataArea
- the data area.
-
drawOutline
Draws an outline for the data area.- Parameters:
g2
- the graphics device.plot
- the plot.dataArea
- the data area.
-
drawItem
void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass) Draws a single data item.- Parameters:
g2
- the graphics device.state
- state information for one chart.dataArea
- the data plot area.plot
- the plot.domainAxis
- the domain axis.rangeAxis
- the range axis.dataset
- the data.row
- the row index (zero-based).column
- the column index (zero-based).pass
- the pass index.
-
drawDomainGridline
Draws a grid line against the domain axis.- Parameters:
g2
- the graphics device.plot
- the plot.dataArea
- the area for plotting data (not yet adjusted for any 3D effect).value
- the value.- See Also:
-
drawRangeGridline
void drawRangeGridline(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value) Draws a grid line against the range axis.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the value axis.dataArea
- the area for plotting data (not yet adjusted for any 3D effect).value
- the value.- See Also:
-
drawDomainMarker
void drawDomainMarker(Graphics2D g2, CategoryPlot plot, CategoryAxis axis, CategoryMarker marker, Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular category on the domain axis.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the category axis.marker
- the marker.dataArea
- the area for plotting data (not including 3D effect).- See Also:
-
drawRangeMarker
void drawRangeMarker(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular value on the range axis.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the value axis.marker
- the marker.dataArea
- the area for plotting data (not including 3D effect).- See Also:
-
getItemMiddle
double getItemMiddle(Comparable rowKey, Comparable columnKey, CategoryDataset dataset, CategoryAxis axis, Rectangle2D area, org.jfree.ui.RectangleEdge edge) Returns the Java2D coordinate for the middle of the specified data item.- Parameters:
rowKey
- the row key.columnKey
- the column key.dataset
- the dataset.axis
- the axis.area
- the data area.edge
- the edge along which the axis lies.- Returns:
- The Java2D coordinate for the middle of the item.
- Since:
- 1.0.11
-