Interface CategoryItemRenderer
- All Known Implementing Classes:
AbstractCategoryItemRenderer
,AreaRenderer
,BarRenderer
,BarRenderer3D
,BoxAndWhiskerRenderer
,CategoryStepRenderer
,DefaultCategoryItemRenderer
,ExtendedStackedBarRenderer
,GanttRenderer
,GroupedStackedBarRenderer
,IntervalBarRenderer
,LayeredBarRenderer
,LevelRenderer
,LineAndShapeRenderer
,MinMaxCategoryRenderer
,MyLineAndShapeRenderer
,StackedAreaRenderer
,StackedBarRenderer
,StackedBarRenderer3D
,StatisticalBarRenderer
,WaterfallBarRenderer
public interface CategoryItemRenderer
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 Type Method Description void
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
drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset data, int row, int column)
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.ItemLabelAnchor
getBaseItemLabelAnchor()
Deprecated.Use getBasePositiveItemLabelPosition() or getBaseNegativeItemLabelPosition().Font
getBaseItemLabelFont()
Returns the base item label font (this is used when no other font setting is available).Paint
getBaseItemLabelPaint()
Returns the base item label paint.Boolean
getBaseItemLabelsVisible()
Returns the base setting for item label visibility.org.jfree.ui.TextAnchor
getBaseItemLabelTextAnchor()
Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().CategoryURLGenerator
getBaseItemURLGenerator()
Returns the base item URL generator.CategoryLabelGenerator
getBaseLabelGenerator()
Returns the base label generator.ItemLabelPosition
getBaseNegativeItemLabelPosition()
Returns the base item label position for negative values.Paint
getBaseOutlinePaint()
Returns the base outline paint.Stroke
getBaseOutlineStroke()
Returns the base outline stroke.Paint
getBasePaint()
Returns the base paint.ItemLabelPosition
getBasePositiveItemLabelPosition()
Returns the base positive item label position.Shape
getBaseShape()
Returns the base shape.Stroke
getBaseStroke()
Returns the base stroke.CategoryToolTipGenerator
getBaseToolTipGenerator()
Returns the base tool tip generator (the "layer 2" generator).ItemLabelAnchor
getItemLabelAnchor(int series, int item)
Deprecated.Use getPositiveItemLabelPosition() or getNegativeItemLabelPosition().Font
getItemLabelFont()
Returns the font used for all item labels.Font
getItemLabelFont(int row, int column)
Returns the font for an item label.Paint
getItemLabelPaint()
Returns the paint used for all item labels.Paint
getItemLabelPaint(int row, int column)
Returns the paint used to draw an item label.org.jfree.ui.TextAnchor
getItemLabelTextAnchor(int series, int item)
Deprecated.Use getPositiveItemLabelPosition() or getNegativeItemLabelPosition().Paint
getItemOutlinePaint(int row, int column)
Returns the paint used to outline data items as they are drawn.Stroke
getItemOutlineStroke(int row, int column)
Returns the stroke used to outline data items.Paint
getItemPaint(int row, int column)
Returns the paint used to fill data items as they are drawn.Shape
getItemShape(int row, int column)
Returns a shape used to represent a data item.Stroke
getItemStroke(int row, int column)
Returns the stroke used to draw data items.CategoryURLGenerator
getItemURLGenerator(int series, int item)
Returns the URL generator for an item.CategoryLabelGenerator
getLabelGenerator(int series, int item)
Returns the item label generator for the specified data item.LegendItem
getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.ItemLabelPosition
getNegativeItemLabelPosition()
Returns the item label position for negative values in ALL series.ItemLabelPosition
getNegativeItemLabelPosition(int row, int column)
Returns the item label position for negative values.CategoryPlot
getPlot()
Returns the plot that the renderer has been assigned to (wherenull
indicates that the renderer is not currently assigned to a plot).ItemLabelPosition
getPositiveItemLabelPosition()
Returns the item label position for positive values in ALL series.ItemLabelPosition
getPositiveItemLabelPosition(int row, int column)
Returns the item label position for positive values.Range
getRangeExtent(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.ItemLabelAnchor
getSeriesItemLabelAnchor(int series)
Deprecated.Use getSeriesPositiveItemLabelPosition() or getSeriesNegativeItemLabelPosition().Font
getSeriesItemLabelFont(int series)
Returns the font for all the item labels in a series.Paint
getSeriesItemLabelPaint(int series)
Returns the paint used to draw the item labels for a series.org.jfree.ui.TextAnchor
getSeriesItemLabelTextAnchor(int series)
Deprecated.Use getSeriesPositiveItemLabelPosition() or getSeriesNegativeItemLabelPosition().CategoryURLGenerator
getSeriesItemURLGenerator(int series)
Returns the item URL generator for a series.CategoryLabelGenerator
getSeriesLabelGenerator(int series)
Returns the item label generator for a series.ItemLabelPosition
getSeriesNegativeItemLabelPosition(int series)
Returns the item label position for all negative values in a series.Paint
getSeriesOutlinePaint(int series)
Returns the paint used to outline an item drawn by the renderer.Stroke
getSeriesOutlineStroke(int series)
Returns the stroke used to outline the items in a series.Paint
getSeriesPaint(int series)
Returns the paint used to fill an item drawn by the renderer.ItemLabelPosition
getSeriesPositiveItemLabelPosition(int series)
Returns the item label position for all positive values in a series.Shape
getSeriesShape(int series)
Returns a shape used to represent the items in a series.Stroke
getSeriesStroke(int series)
Returns the stroke used to draw the items in a series.CategoryToolTipGenerator
getSeriesToolTipGenerator(int series)
Returns the tool tip generator for the specified series (a "layer 1" generator).CategoryToolTipGenerator
getToolTipGenerator()
Returns the tool tip generator that will be used for ALL items in the dataset (the "layer 0" generator).CategoryToolTipGenerator
getToolTipGenerator(int row, int column)
Returns the tool tip generator that should be used for the specified item.CategoryItemRendererState
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.void
removeChangeListener(RendererChangeListener listener)
Removes a change listener.void
setBaseItemLabelAnchor(ItemLabelAnchor anchor)
Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().void
setBaseItemLabelFont(Font font)
Sets the base item label font 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.void
setBaseItemLabelsVisible(Boolean visible)
Sets the base setting for item label visibility.void
setBaseItemLabelsVisible(Boolean visible, boolean notify)
Sets the base visibility for item labels and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelTextAnchor(org.jfree.ui.TextAnchor anchor)
Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().void
setBaseItemURLGenerator(CategoryURLGenerator generator)
Sets the base item URL generator.void
setBaseLabelGenerator(CategoryLabelGenerator generator)
Sets the base label generator and sends aRendererChangeEvent
to all registered listeners.void
setBaseNegativeItemLabelPosition(ItemLabelPosition position)
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
setBasePositiveItemLabelPosition(ItemLabelPosition position)
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
setBaseShape(Shape shape)
Sets the base shape and sends aRendererChangeEvent
to all registered listeners.void
setBaseStroke(Stroke stroke)
Sets the base stroke.void
setBaseToolTipGenerator(CategoryToolTipGenerator generator)
Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelAnchor(ItemLabelAnchor anchor)
Deprecated.Use setPositiveItemLabelPosition() or setNegativeItemLabelPosition().void
setItemLabelFont(Font font)
Sets the item label font for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelPaint(Paint paint)
Sets the item label paint for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelsVisible(boolean visible)
Sets a flag that controls whether or not the item labels for ALL series are visible.void
setItemLabelsVisible(Boolean visible)
Sets a flag that controls whether or not the item labels for ALL series are visible.void
setItemLabelsVisible(Boolean visible, boolean notify)
Sets the visibility of item labels for ALL series and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setItemLabelTextAnchor(org.jfree.ui.TextAnchor anchor)
Deprecated.Use setPositiveItemLabelPosition() or setNegativeItemLabelPosition().void
setItemURLGenerator(CategoryURLGenerator generator)
Sets the item URL generator for ALL series.void
setLabelGenerator(CategoryLabelGenerator generator)
Sets the item label generator for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setNegativeItemLabelPosition(ItemLabelPosition position)
Sets the item label position for negative values in ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
Sets the item label position for negative values in ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setOutlinePaint(Paint paint)
Sets the outline paint for ALL series (optional).void
setOutlineStroke(Stroke stroke)
Sets the outline stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setPaint(Paint paint)
Sets the paint to be used for ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setPlot(CategoryPlot plot)
Sets the plot that the renderer has been assigned to.void
setPositiveItemLabelPosition(ItemLabelPosition position)
Sets the item label position for positive values in ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setPositiveItemLabelPosition(ItemLabelPosition position, boolean notify)
Sets the positive item label position for ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelAnchor(int series, ItemLabelAnchor anchor)
Deprecated.Use setSeriesPositiveItemLabelPosition() or setSeriesNegativeItemLabelPosition().void
setSeriesItemLabelFont(int series, Font font)
Sets the item label font 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
setSeriesItemLabelTextAnchor(int series, org.jfree.ui.TextAnchor anchor)
Deprecated.Use setSeriesPositiveItemLabelPosition() or setSeriesNegativeItemLabelPosition().void
setSeriesItemURLGenerator(int series, CategoryURLGenerator generator)
Sets the item URL generator for a series.void
setSeriesLabelGenerator(int series, CategoryLabelGenerator generator)
Sets the item label generator for a series and sends aRendererChangeEvent
to all registered listeners.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 a.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
setShape(Shape shape)
Sets the shape for ALL series (optional) and sends aRendererChangeEvent
to all registered listeners.void
setStroke(Stroke stroke)
Sets the stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setToolTipGenerator(CategoryToolTipGenerator generator)
Sets the tool tip generator for ALL series and sends aRendererChangeEvent
to all registered listeners.
-
Method Details
-
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
).
-
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).
-
addChangeListener
Adds a change listener.- Parameters:
listener
- the listener.
-
removeChangeListener
Removes a change listener.- Parameters:
listener
- the listener.
-
getRangeExtent
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).
-
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
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 (never
null
).
-
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).
-
getBasePaint
Paint getBasePaint()Returns the base paint.- Returns:
- the base paint (never
null
).
-
setBasePaint
Sets the base paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
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
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 (never
null
).
-
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).
-
getBaseOutlinePaint
Paint getBaseOutlinePaint()Returns the base outline paint.- Returns:
- the paint (never
null
).
-
setBaseOutlinePaint
Sets the base outline paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
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
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
).
-
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).
-
getBaseStroke
Stroke getBaseStroke()Returns the base stroke.- Returns:
- the base stroke (never
null
).
-
setBaseStroke
Sets the base stroke.- Parameters:
stroke
- the stroke (null
not permitted).
-
getItemOutlineStroke
Returns the stroke used to outline data items.The default implementation passes control to the getSeriesOutlineStroke 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
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 (never
null
).
-
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).
-
getBaseOutlineStroke
Stroke getBaseOutlineStroke()Returns the base outline stroke.- Returns:
- the stroke (never
null
).
-
setBaseOutlineStroke
Sets the base outline stroke and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).
-
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
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 (never
null
).
-
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).
-
getBaseShape
Shape getBaseShape()Returns the base shape.- Returns:
- the shape (never
null
).
-
setBaseShape
Sets the base shape and sends aRendererChangeEvent
to all registered listeners.- Parameters:
shape
- the shape (null
not permitted).
-
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.
-
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.
-
setItemLabelsVisible
void setItemLabelsVisible(boolean visible)Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag.
-
setItemLabelsVisible
Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag (null
permitted).
-
setItemLabelsVisible
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.
-
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.
-
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).
-
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.
-
getBaseItemLabelsVisible
Boolean getBaseItemLabelsVisible()Returns the base setting for item label visibility.- Returns:
- A flag (possibly
null
).
-
setBaseItemLabelsVisible
void setBaseItemLabelsVisible(boolean visible)Sets the base flag that controls whether or not item labels are visible.- Parameters:
visible
- the flag.
-
setBaseItemLabelsVisible
Sets the base setting for item label visibility.- Parameters:
visible
- the flag (null
permitted).
-
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.
-
getLabelGenerator
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
).
-
getSeriesLabelGenerator
Returns the item label generator for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The label generator (possibly
null
).
-
setLabelGenerator
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).
-
setSeriesLabelGenerator
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.
-
getBaseLabelGenerator
CategoryLabelGenerator getBaseLabelGenerator()Returns the base label generator.- Returns:
- The generator (possibly
null
).
-
setBaseLabelGenerator
Sets the base label generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
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()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
).
-
setToolTipGenerator
Sets the tool tip generator for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
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
).
-
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).
-
getBaseToolTipGenerator
CategoryToolTipGenerator getBaseToolTipGenerator()Returns the base tool tip generator (the "layer 2" generator).- Returns:
- The tool tip generator (possibly
null
).
-
setBaseToolTipGenerator
Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
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()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
).
-
setItemLabelFont
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).
-
getSeriesItemLabelFont
Returns the font for all the item labels in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The font (possibly
null
).
-
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).
-
getBaseItemLabelFont
Font getBaseItemLabelFont()Returns the base item label font (this is used when no other font setting is available).- Returns:
- The font (
never
null).
-
setBaseItemLabelFont
Sets the base item label font and sends aRendererChangeEvent
to all registered listeners.- Parameters:
font
- the font (null
not permitted).
-
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()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
).
-
setItemLabelPaint
Sets the item label paint for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
permitted).
-
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
).
-
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).
-
getBaseItemLabelPaint
Paint getBaseItemLabelPaint()Returns the base item label paint.- Returns:
- The paint (never
null
).
-
setBaseItemLabelPaint
Sets the base item label paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
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()Returns the item label position for positive values in ALL series.- Returns:
- the item label position (possibly
null
).
-
setPositiveItemLabelPosition
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).
-
setPositiveItemLabelPosition
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?
-
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.
-
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).
-
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?
-
getBasePositiveItemLabelPosition
ItemLabelPosition getBasePositiveItemLabelPosition()Returns the base positive item label position.- Returns:
- The position.
-
setBasePositiveItemLabelPosition
Sets the base positive item label position.- Parameters:
position
- the position.
-
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?
-
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()Returns the item label position for negative values in ALL series.- Returns:
- the item label position (possibly
null
).
-
setNegativeItemLabelPosition
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).
-
setNegativeItemLabelPosition
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?
-
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.
-
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).
-
setSeriesNegativeItemLabelPosition
Sets the item label position for negative values in a series and (if requested) sends a.RendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?
-
getBaseNegativeItemLabelPosition
ItemLabelPosition getBaseNegativeItemLabelPosition()Returns the base item label position for negative values.- Returns:
- The position.
-
setBaseNegativeItemLabelPosition
Sets the base item label position for negative values and sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position.
-
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?
-
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.
-
getSeriesItemURLGenerator
Returns the item URL generator for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The URL generator.
-
setItemURLGenerator
Sets the item URL generator for ALL series.- Parameters:
generator
- the generator.
-
setSeriesItemURLGenerator
Sets the item URL generator for a series.- Parameters:
series
- the series index (zero-based).generator
- the generator.
-
getBaseItemURLGenerator
CategoryURLGenerator getBaseItemURLGenerator()Returns the base item URL generator.- Returns:
- The item URL generator.
-
setBaseItemURLGenerator
Sets the base item URL generator.- Parameters:
generator
- the item URL generator.
-
getLegendItem
Returns a legend item for a series.- 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 data, int row, int column)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.data
- the data.row
- the row index (zero-based).column
- the column index (zero-based).
-
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.
-
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.
-
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).
-
getItemLabelAnchor
Deprecated.Use getPositiveItemLabelPosition() or getNegativeItemLabelPosition().Returns the item label anchor for an item.- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The item label anchor.
-
getSeriesItemLabelAnchor
Deprecated.Use getSeriesPositiveItemLabelPosition() or getSeriesNegativeItemLabelPosition().Returns the item label anchor for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The anchor.
-
setItemLabelAnchor
Deprecated.Use setPositiveItemLabelPosition() or setNegativeItemLabelPosition().Sets the item label anchor for ALL series.- Parameters:
anchor
- the anchor.
-
setSeriesItemLabelAnchor
Deprecated.Use setSeriesPositiveItemLabelPosition() or setSeriesNegativeItemLabelPosition().Sets the item label anchor for a series.- Parameters:
series
- the series index (zero-based).anchor
- the anchor.
-
getBaseItemLabelAnchor
ItemLabelAnchor getBaseItemLabelAnchor()Deprecated.Use getBasePositiveItemLabelPosition() or getBaseNegativeItemLabelPosition().Returns the base item label anchor.- Returns:
- The item label anchor.
-
setBaseItemLabelAnchor
Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().Sets the base item label anchor.- Parameters:
anchor
- the base item label anchor.
-
getItemLabelTextAnchor
org.jfree.ui.TextAnchor getItemLabelTextAnchor(int series, int item)Deprecated.Use getPositiveItemLabelPosition() or getNegativeItemLabelPosition().Returns the item label text anchor for an item.- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The item label text anchor.
-
getSeriesItemLabelTextAnchor
org.jfree.ui.TextAnchor getSeriesItemLabelTextAnchor(int series)Deprecated.Use getSeriesPositiveItemLabelPosition() or getSeriesNegativeItemLabelPosition().Returns the item label text anchor for a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The anchor.
-
setItemLabelTextAnchor
void setItemLabelTextAnchor(org.jfree.ui.TextAnchor anchor)Deprecated.Use setPositiveItemLabelPosition() or setNegativeItemLabelPosition().Sets the item label text anchor for ALL series.- Parameters:
anchor
- the anchor.
-
setSeriesItemLabelTextAnchor
void setSeriesItemLabelTextAnchor(int series, org.jfree.ui.TextAnchor anchor)Deprecated.Use setSeriesPositiveItemLabelPosition() or setSeriesNegativeItemLabelPosition().Sets the item label text anchor for a series.- Parameters:
series
- the series index (zero-based).anchor
- the anchor.
-
getBaseItemLabelTextAnchor
org.jfree.ui.TextAnchor getBaseItemLabelTextAnchor()Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().Returns the base item label text anchor.- Returns:
- The item label text anchor.
-
setBaseItemLabelTextAnchor
void setBaseItemLabelTextAnchor(org.jfree.ui.TextAnchor anchor)Deprecated.Use setBasePositiveItemLabelPosition() or setBaseNegativeItemLabelPosition().Sets the base item label text anchor.- Parameters:
anchor
- the item label text anchor.
-