Module platform
Package org.jfree.chart.renderer.category

Interface CategoryItemRenderer

All Superinterfaces:
LegendItemSource
All Known Implementing Classes:
AbstractCategoryItemRenderer, AreaRenderer, BarRenderer, BoxAndWhiskerRenderer, CategoryStepRenderer, DefaultCategoryItemRenderer, GanttRenderer, GroupedStackedBarRenderer, IntervalBarRenderer, LayeredBarRenderer, LevelRenderer, LineAndShapeRenderer, MinMaxCategoryRenderer, ScatterRenderer, StackedAreaRenderer, StackedBarRenderer, StatisticalBarRenderer, StatisticalLineAndShapeRenderer, WaterfallBarRenderer
public interface CategoryItemRenderer extends LegendItemSource
A plug-in object that is used by the 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 two layer approach. When looking up an attribute (for example, the outline paint) the renderer first checks to see if there is a setting that applies to a specific series that the renderer draws. If there is, that setting is used, but if it is null the renderer looks up the default setting. Some attributes allow the base setting to be null, while other attributes enforce non-null values.

  • 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 (where null indicates that the renderer is not currently assigned to a plot).
      Returns:
      The plot (possibly null).
      See Also:

    • setPlot

      void setPlot(CategoryPlot plot)
      Sets the plot that the renderer has been assigned to. This method is usually called by the CategoryPlot, in normal usage you shouldn't need to call this method directly.
      Parameters:
      plot - the plot (null not permitted).
      See Also:

    • addChangeListener

      void addChangeListener(RendererChangeListener listener)
      Adds a change listener.
      Parameters:
      listener - the listener.
      See Also:

    • removeChangeListener

      void removeChangeListener(RendererChangeListener listener)
      Removes a change listener.
      Parameters:
      listener - the listener.
      See Also:

    • findRangeBounds

      Range findRangeBounds(CategoryDataset dataset)
      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 is null 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(int series)
      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

      void setSeriesVisible(int series, Boolean visible)
      Sets the flag that controls whether a series is visible and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      visible - the flag (null permitted).
      See Also:

    • setSeriesVisible

      void setSeriesVisible(int series, Boolean visible, boolean notify)
      Sets the flag that controls whether a series is visible and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index.
      visible - the flag (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultSeriesVisible

      boolean getDefaultSeriesVisible()
      Returns the default visibility for all series.
      Returns:
      The default visibility.
      See Also:

    • setDefaultSeriesVisible

      void setDefaultSeriesVisible(boolean visible)
      Sets the default visibility and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the flag.
      See Also:

    • setDefaultSeriesVisible

      void setDefaultSeriesVisible(boolean visible, boolean notify)
      Sets the default visibility and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the visibility.
      notify - notify listeners?
      See Also:

    • isSeriesVisibleInLegend

      boolean isSeriesVisibleInLegend(int series)
      Returns true if the series should be shown in the legend, and false otherwise.
      Parameters:
      series - the series index.
      Returns:
      A boolean.

    • getSeriesVisibleInLegend

      Boolean getSeriesVisibleInLegend(int series)
      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 the isSeriesVisibleInLegend(int) method.
      Parameters:
      series - the series index (zero-based).
      Returns:
      The flag (possibly null).
      See Also:

    • setSeriesVisibleInLegend

      void setSeriesVisibleInLegend(int series, Boolean visible)
      Sets the flag that controls whether a series is visible in the legend and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      visible - the flag (null permitted).
      See Also:

    • setSeriesVisibleInLegend

      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 a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index.
      visible - the flag (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultSeriesVisibleInLegend

      boolean getDefaultSeriesVisibleInLegend()
      Returns the default visibility in the legend for all series.
      Returns:
      The default visibility.
      See Also:

    • setDefaultSeriesVisibleInLegend

      void setDefaultSeriesVisibleInLegend(boolean visible)
      Sets the default visibility in the legend and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the flag.
      See Also:

    • setDefaultSeriesVisibleInLegend

      void setDefaultSeriesVisibleInLegend(boolean visible, boolean notify)
      Sets the default visibility in the legend and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the visibility.
      notify - notify listeners?
      See Also:

    • getItemPaint

      Paint getItemPaint(int row, int column)
      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).

    • getSeriesPaint

      Paint getSeriesPaint(int series)
      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

      void setSeriesPaint(int series, Paint paint)
      Sets the paint used for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      paint - the paint (null permitted).
      See Also:

    • setSeriesPaint

      void setSeriesPaint(int series, Paint paint, boolean notify)
      Sets the paint used for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      paint - the paint (null permitted).
      notify - notify listeners?

    • getDefaultPaint

      Paint getDefaultPaint()
      Returns the default paint. During rendering, a renderer will first look up the series paint and, if this is null, it will use the default paint.
      Returns:
      The default paint (never null).
      See Also:

    • setDefaultPaint

      void setDefaultPaint(Paint paint)
      Sets the default paint and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • setDefaultPaint

      void setDefaultPaint(Paint paint, boolean notify)
      Sets the default paint and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      notify - notify listeners?
      See Also:

    • getItemFillPaint

      Paint getItemFillPaint(int row, int column)
      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).

    • getSeriesFillPaint

      Paint getSeriesFillPaint(int series)
      Returns the paint used to fill an item drawn by the renderer.
      Parameters:
      series - the series (zero-based index).
      Returns:
      The paint (possibly null).
      See Also:

    • setSeriesFillPaint

      void setSeriesFillPaint(int series, Paint paint)
      Sets the paint used for a series outline and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      paint - the paint (null permitted).
      See Also:

    • getDefaultFillPaint

      Paint getDefaultFillPaint()
      Returns the default outline paint.
      Returns:
      The paint (never null).
      See Also:

    • setDefaultFillPaint

      void setDefaultFillPaint(Paint paint)
      Sets the default outline paint and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • getItemOutlinePaint

      Paint getItemOutlinePaint(int row, int column)
      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).

    • getSeriesOutlinePaint

      Paint getSeriesOutlinePaint(int series)
      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

      void setSeriesOutlinePaint(int series, Paint paint)
      Sets the paint used for a series outline and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      paint - the paint (null permitted).
      See Also:

    • setSeriesOutlinePaint

      void setSeriesOutlinePaint(int series, Paint paint, boolean notify)
      Sets the paint used for a series outline and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      paint - the paint (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultOutlinePaint

      Paint getDefaultOutlinePaint()
      Returns the default outline paint. During rendering, the renderer will look up the series outline paint and, if this is null, it will use the default outline paint.
      Returns:
      The paint (never null).
      See Also:

    • setDefaultOutlinePaint

      void setDefaultOutlinePaint(Paint paint)
      Sets the default outline paint and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • setDefaultOutlinePaint

      void setDefaultOutlinePaint(Paint paint, boolean notify)
      Sets the default outline paint and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      notify - notify listeners?
      See Also:

    • getItemStroke

      Stroke getItemStroke(int row, int column)
      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).

    • getSeriesStroke

      Stroke getSeriesStroke(int series)
      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

      void setSeriesStroke(int series, Stroke stroke)
      Sets the stroke used for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      stroke - the stroke (null permitted).
      See Also:

    • setSeriesStroke

      void setSeriesStroke(int series, Stroke stroke, boolean notify)
      Sets the stroke used for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      stroke - the stroke (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultStroke

      Stroke getDefaultStroke()
      Returns the default stroke.
      Returns:
      The default stroke (never null).
      See Also:

    • setDefaultStroke

      void setDefaultStroke(Stroke stroke)
      Sets the default stroke and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null not permitted).
      See Also:

    • setDefaultStroke

      void setDefaultStroke(Stroke stroke, boolean notify)
      Sets the default stroke and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null not permitted).
      notify - notify listeners?
      See Also:

    • getItemOutlineStroke

      Stroke getItemOutlineStroke(int row, int column)
      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).

    • getSeriesOutlineStroke

      Stroke getSeriesOutlineStroke(int series)
      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

      void setSeriesOutlineStroke(int series, Stroke stroke)
      Sets the outline stroke used for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      stroke - the stroke (null permitted).
      See Also:

    • setSeriesOutlineStroke

      void setSeriesOutlineStroke(int series, Stroke stroke, boolean notify)
      Sets the outline stroke used for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      stroke - the stroke (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultOutlineStroke

      Stroke getDefaultOutlineStroke()
      Returns the default outline stroke.
      Returns:
      The stroke (never null).
      See Also:

    • setDefaultOutlineStroke

      void setDefaultOutlineStroke(Stroke stroke)
      Sets the default outline stroke and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null not permitted).
      See Also:

    • setDefaultOutlineStroke

      void setDefaultOutlineStroke(Stroke stroke, boolean notify)
      Sets the default outline stroke and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null not permitted).
      notify - notify listeners?
      See Also:

    • getItemShape

      Shape getItemShape(int row, int column)
      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).

    • getSeriesShape

      Shape getSeriesShape(int series)
      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

      void setSeriesShape(int series, Shape shape)
      Sets the shape used for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      shape - the shape (null permitted).
      See Also:

    • setSeriesShape

      void setSeriesShape(int series, Shape shape, boolean notify)
      Sets the shape used for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      shape - the shape (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultShape

      Shape getDefaultShape()
      Returns the default shape.
      Returns:
      The shape (never null).
      See Also:

    • setDefaultShape

      void setDefaultShape(Shape shape)
      Sets the default shape and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      shape - the shape (null not permitted).
      See Also:

    • setDefaultShape

      void setDefaultShape(Shape shape, boolean notify)
      Sets the default shape and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      shape - the shape (null not permitted).
      notify - notify listeners?
      See Also:

    • isItemLabelVisible

      boolean isItemLabelVisible(int row, int column)
      Returns true if an item label is visible, and false otherwise.
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      A boolean.

    • isSeriesItemLabelsVisible

      boolean isSeriesItemLabelsVisible(int series)
      Returns true if the item labels for a series are visible, and false 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

      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 (null permitted).
      See Also:

    • setSeriesItemLabelsVisible

      void setSeriesItemLabelsVisible(int series, Boolean visible, boolean notify)
      Sets the visibility of item labels for a series and, if requested, sends a RendererChangeEvent 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:

    • getDefaultItemLabelsVisible

      boolean getDefaultItemLabelsVisible()
      Returns the default setting for item label visibility. A null result should be interpreted as equivalent to Boolean.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:

    • setDefaultItemLabelsVisible

      void setDefaultItemLabelsVisible(boolean visible)
      Sets the default flag that controls whether or not item labels are visible and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the flag.
      See Also:

    • setDefaultItemLabelsVisible

      void setDefaultItemLabelsVisible(boolean visible, boolean notify)
      Sets the default visibility for item labels and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      visible - the visibility flag.
      notify - a flag that controls whether or not listeners are notified.
      See Also:

    • getItemLabelGenerator

      CategoryItemLabelGenerator getItemLabelGenerator(int series, int item)
      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).

    • getSeriesItemLabelGenerator

      CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series)
      Returns the item label generator for a series.
      Parameters:
      series - the series index (zero-based).
      Returns:
      The label generator (possibly null).
      See Also:

    • setSeriesItemLabelGenerator

      void setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator)
      Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator.
      See Also:

    • setSeriesItemLabelGenerator

      void setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator, boolean notify)
      Sets the item label generator for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator.
      notify - notify listeners?
      See Also:

    • getDefaultItemLabelGenerator

      CategoryItemLabelGenerator getDefaultItemLabelGenerator()
      Returns the default item label generator.
      Returns:
      The generator (possibly null).
      See Also:

    • setDefaultItemLabelGenerator

      void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator)
      Sets the default item label generator and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      See Also:

    • setDefaultItemLabelGenerator

      void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator, boolean notify)
      Sets the default item label generator and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      notify - notify listeners?
      See Also:

    • getToolTipGenerator

      CategoryToolTipGenerator getToolTipGenerator(int row, int column)
      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).

    • getSeriesToolTipGenerator

      CategoryToolTipGenerator getSeriesToolTipGenerator(int series)
      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

      void setSeriesToolTipGenerator(int series, CategoryToolTipGenerator generator)
      Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator (null permitted).
      See Also:

    • setSeriesToolTipGenerator

      void setSeriesToolTipGenerator(int series, CategoryToolTipGenerator generator, boolean notify)
      Sets the tool tip generator for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultToolTipGenerator

      CategoryToolTipGenerator getDefaultToolTipGenerator()
      Returns the default tool tip generator (the "layer 2" generator).
      Returns:
      The tool tip generator (possibly null).
      See Also:

    • setDefaultToolTipGenerator

      void setDefaultToolTipGenerator(CategoryToolTipGenerator generator)
      Sets the default tool tip generator and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      See Also:

    • setDefaultToolTipGenerator

      void setDefaultToolTipGenerator(CategoryToolTipGenerator generator, boolean notify)
      Sets the default tool tip generator and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).
      notify - notify listeners?
      See Also:

    • getItemLabelFont

      Font getItemLabelFont(int row, int column)
      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).

    • getSeriesItemLabelFont

      Font getSeriesItemLabelFont(int series)
      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

      void setSeriesItemLabelFont(int series, Font font)
      Sets the item label font for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      font - the font (null permitted).
      See Also:

    • setSeriesItemLabelFont

      void setSeriesItemLabelFont(int series, Font font, boolean notify)
      Sets the item label font for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      font - the font (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultItemLabelFont

      Font getDefaultItemLabelFont()
      Returns the default item label font (this is used when no other font setting is available).
      Returns:
      The font (never null).
      See Also:

    • setDefaultItemLabelFont

      void setDefaultItemLabelFont(Font font)
      Sets the default item label font and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      font - the font (null not permitted).
      See Also:

    • setDefaultItemLabelFont

      void setDefaultItemLabelFont(Font font, boolean notify)
      Sets the default item label font and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      font - the font (null not permitted).
      notify - notify listeners?
      See Also:

    • getItemLabelPaint

      Paint getItemLabelPaint(int row, int column)
      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).

    • getSeriesItemLabelPaint

      Paint getSeriesItemLabelPaint(int series)
      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

      void setSeriesItemLabelPaint(int series, Paint paint)
      Sets the item label paint for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series (zero based index).
      paint - the paint (null permitted).
      See Also:

    • setSeriesItemLabelPaint

      void setSeriesItemLabelPaint(int series, Paint paint, boolean notify)
      Sets the item label paint for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series (zero based index).
      paint - the paint (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultItemLabelPaint

      Paint getDefaultItemLabelPaint()
      Returns the default item label paint.
      Returns:
      The paint (never null).
      See Also:

    • setDefaultItemLabelPaint

      void setDefaultItemLabelPaint(Paint paint)
      Sets the default item label paint and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • setDefaultItemLabelPaint

      void setDefaultItemLabelPaint(Paint paint, boolean notify)
      Sets the default item label paint and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      notify - notify listeners?
      See Also:

    • getPositiveItemLabelPosition

      ItemLabelPosition getPositiveItemLabelPosition(int row, int column)
      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).

    • getSeriesPositiveItemLabelPosition

      ItemLabelPosition getSeriesPositiveItemLabelPosition(int series)
      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

      void setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position)
      Sets the item label position for all positive values in a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      position - the position (null permitted).
      See Also:

    • setSeriesPositiveItemLabelPosition

      void setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position, boolean notify)
      Sets the item label position for all positive 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?
      See Also:

    • getDefaultPositiveItemLabelPosition

      ItemLabelPosition getDefaultPositiveItemLabelPosition()
      Returns the default positive item label position.
      Returns:
      The position.
      See Also:

    • setDefaultPositiveItemLabelPosition

      void setDefaultPositiveItemLabelPosition(ItemLabelPosition position)
      Sets the default positive item label position.
      Parameters:
      position - the position.
      See Also:

    • setDefaultPositiveItemLabelPosition

      void setDefaultPositiveItemLabelPosition(ItemLabelPosition position, boolean notify)
      Sets the default positive item label position and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      position - the position.
      notify - notify registered listeners?
      See Also:

    • getNegativeItemLabelPosition

      ItemLabelPosition getNegativeItemLabelPosition(int row, int column)
      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.

    • getSeriesNegativeItemLabelPosition

      ItemLabelPosition getSeriesNegativeItemLabelPosition(int series)
      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

      void setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position)
      Sets the item label position for negative values in a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      position - the position (null permitted).
      See Also:

    • setSeriesNegativeItemLabelPosition

      void setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position, boolean notify)
      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?
      See Also:

    • getDefaultNegativeItemLabelPosition

      ItemLabelPosition getDefaultNegativeItemLabelPosition()
      Returns the default item label position for negative values.
      Returns:
      The position.
      See Also:

    • setDefaultNegativeItemLabelPosition

      void setDefaultNegativeItemLabelPosition(ItemLabelPosition position)
      Sets the default item label position for negative values and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      position - the position.
      See Also:

    • setDefaultNegativeItemLabelPosition

      void setDefaultNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
      Sets the default negative item label position and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      position - the position.
      notify - notify registered listeners?
      See Also:

    • getItemCreateEntity

      boolean getItemCreateEntity(int series, int item)
      Returns a flag that determines whether or not an entity is generated for the specified item. The standard implementation of this method will typically return the flag for the series or, if that is null, the value returned by getDefaultCreateEntities().
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      A boolean.

    • getSeriesCreateEntities

      Boolean getSeriesCreateEntities(int series)
      Returns a boolean indicating whether or not entities should be created for the items in a series.
      Parameters:
      series - the series index (zero-based).
      Returns:
      The flag for the series (possibly null).

    • setSeriesCreateEntities

      void setSeriesCreateEntities(int series, Boolean create)
      Sets a flag that indicates whether or not entities should be created during rendering for the items in the specified series, and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      create - the new flag value (null permitted).

    • setSeriesCreateEntities

      void setSeriesCreateEntities(int series, Boolean create, boolean notify)
      Sets a flag that indicates whether or not entities should be created during rendering for the items in the specified series, and sends a RendererChangeEvent to all registered listeners if requested.
      Parameters:
      series - the series index (zero-based).
      create - the new flag value (null permitted).
      notify - notify listeners?

    • getDefaultCreateEntities

      boolean getDefaultCreateEntities()
      Returns the default value for the flag that controls whether or not an entity is created for an item during rendering.
      Returns:
      A boolean.

    • setDefaultCreateEntities

      void setDefaultCreateEntities(boolean create)
      Sets the default value for the flag that controls whether or not an entity is created for an item during rendering and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      create - the new flag value.

    • setDefaultCreateEntities

      void setDefaultCreateEntities(boolean create, boolean notify)
      Sets the default value for the flag that controls whether or not an entity is created for an item during rendering and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      create - the new flag value.
      notify - notify listeners?

    • getItemURLGenerator

      CategoryURLGenerator getItemURLGenerator(int series, int item)
      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

      CategoryURLGenerator getSeriesItemURLGenerator(int series)
      Returns the item URL generator for a series.
      Parameters:
      series - the series index (zero-based).
      Returns:
      The URL generator.
      See Also:

    • setSeriesItemURLGenerator

      void setSeriesItemURLGenerator(int series, CategoryURLGenerator generator)
      Sets the item URL generator for a series and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator (null permitted).
      See Also:

    • setSeriesItemURLGenerator

      void setSeriesItemURLGenerator(int series, CategoryURLGenerator generator, boolean notify)
      Sets the item URL generator for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      series - the series index (zero-based).
      generator - the generator (null permitted).
      notify - notify listeners?
      See Also:

    • getDefaultItemURLGenerator

      CategoryURLGenerator getDefaultItemURLGenerator()
      Returns the default item URL generator.
      Returns:
      The item URL generator (possibly null).
      See Also:

    • setDefaultItemURLGenerator

      void setDefaultItemURLGenerator(CategoryURLGenerator generator)
      Sets the default item URL generator and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the item URL generator (null permitted).
      See Also:

    • setDefaultItemURLGenerator

      void setDefaultItemURLGenerator(CategoryURLGenerator generator, boolean notify)
      Sets the default item URL generator and, if requested, sends a RendererChangeEvent to all registered listeners.
      Parameters:
      generator - the item URL generator (null permitted).
      notify - notify listeners?
      See Also:

    • getLegendItem

      LegendItem getLegendItem(int datasetIndex, int series)
      Returns a legend item for a series. This method can return null, 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

      void drawBackground(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
      Draws a background for the data area.
      Parameters:
      g2 - the graphics device.
      plot - the plot.
      dataArea - the data area.

    • drawOutline

      void drawOutline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
      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

      void drawDomainGridline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value)
      Draws a grid line against the domain axis.
      Parameters:
      g2 - the graphics device.
      plot - the plot.
      dataArea - the area for plotting data.
      value - the value.

    • drawRangeLine

      void drawRangeLine(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)
      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.
      value - the value.
      paint - the paint (null not permitted).
      stroke - the line stroke (null not permitted).

    • 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.
      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.
      See Also:

    • getItemMiddle

      double getItemMiddle(Comparable rowKey, Comparable columnKey, CategoryDataset dataset, CategoryAxis axis, Rectangle2D area, 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.