org.jfree.chart.renderer.category.CategoryItemRenderer Maven / Gradle / Ivy
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------------------
* CategoryItemRenderer.java
* -------------------------
*
* (C) Copyright 2001-2020, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): Mark Watson (www.markwatson.com);
*
*/
package org.jfree.chart.renderer.category;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.Shape;
import java.awt.Stroke;
import java.awt.geom.Rectangle2D;
import org.jfree.chart.LegendItem;
import org.jfree.chart.LegendItemSource;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.event.RendererChangeEvent;
import org.jfree.chart.event.RendererChangeListener;
import org.jfree.chart.labels.CategoryItemLabelGenerator;
import org.jfree.chart.labels.CategoryToolTipGenerator;
import org.jfree.chart.labels.ItemLabelPosition;
import org.jfree.chart.plot.CategoryMarker;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.Marker;
import org.jfree.chart.plot.PlotRenderingInfo;
import org.jfree.chart.ui.RectangleEdge;
import org.jfree.chart.urls.CategoryURLGenerator;
import org.jfree.data.Range;
import org.jfree.data.category.CategoryDataset;
/**
* A plug-in object that is used by the {@link CategoryPlot} class to display
* individual data items from a {@link 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
* {@link 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
* {@code null} the renderer looks up the default setting. Some attributes
* allow the base setting to be {@code null}, while other attributes enforce
* non-{@code null} values.
*/
public interface CategoryItemRenderer extends LegendItemSource {
/**
* 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.
*
* @return The pass count.
*/
public int getPassCount();
/**
* Returns the plot that the renderer has been assigned to (where
* {@code null} indicates that the renderer is not currently assigned
* to a plot).
*
* @return The plot (possibly {@code null}).
*
* @see #setPlot(CategoryPlot)
*/
public CategoryPlot getPlot();
/**
* Sets the plot that the renderer has been assigned to. This method is
* usually called by the {@link CategoryPlot}, in normal usage you
* shouldn't need to call this method directly.
*
* @param plot the plot ({@code null} not permitted).
*
* @see #getPlot()
*/
public void setPlot(CategoryPlot plot);
/**
* Adds a change listener.
*
* @param listener the listener.
*
* @see #removeChangeListener(RendererChangeListener)
*/
public void addChangeListener(RendererChangeListener listener);
/**
* Removes a change listener.
*
* @param listener the listener.
*
* @see #addChangeListener(RendererChangeListener)
*/
public void removeChangeListener(RendererChangeListener listener);
/**
* Returns the range of values the renderer requires to display all the
* items from the specified dataset.
*
* @param dataset the dataset ({@code null} permitted).
*
* @return The range (or {@code null} if the dataset is
* {@code null} or empty).
*/
public Range findRangeBounds(CategoryDataset dataset);
/**
* 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.
*
* @param g2 the graphics device.
* @param dataArea the area inside the axes.
* @param plot the plot.
* @param rendererIndex the renderer index.
* @param info collects chart rendering information for return to caller.
*
* @return A state object (maintains state information relevant to one
* chart drawing).
*/
public CategoryItemRendererState initialise(Graphics2D g2,
Rectangle2D dataArea,
CategoryPlot plot,
int rendererIndex,
PlotRenderingInfo info);
/**
* Returns a boolean that indicates whether or not the specified item
* should be drawn (this is typically used to hide an entire series).
*
* @param series the series index.
* @param item the item index.
*
* @return A boolean.
*/
public boolean getItemVisible(int series, int item);
/**
* Returns a boolean that indicates whether or not the specified series
* should be drawn (this is typically used to hide an entire series).
*
* @param series the series index.
*
* @return A boolean.
*/
public boolean isSeriesVisible(int series);
/**
* Returns the flag that controls whether a series is visible.
*
* @param series the series index (zero-based).
*
* @return The flag (possibly {@code null}).
*
* @see #setSeriesVisible(int, Boolean)
*/
public Boolean getSeriesVisible(int series);
/**
* Sets the flag that controls whether a series is visible and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param visible the flag ({@code null} permitted).
*
* @see #getSeriesVisible(int)
*/
public void setSeriesVisible(int series, Boolean visible);
/**
* Sets the flag that controls whether a series is visible and, if
* requested, sends a {@link RendererChangeEvent} to all registered
* listeners.
*
* @param series the series index.
* @param visible the flag ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesVisible(int)
*/
public void setSeriesVisible(int series, Boolean visible, boolean notify);
/**
* Returns the default visibility for all series.
*
* @return The default visibility.
*
* @see #setDefaultSeriesVisible(boolean)
*/
public boolean getDefaultSeriesVisible();
/**
* Sets the default visibility and sends a {@link RendererChangeEvent} to all
* registered listeners.
*
* @param visible the flag.
*
* @see #getDefaultSeriesVisible()
*/
public void setDefaultSeriesVisible(boolean visible);
/**
* Sets the default visibility and, if requested, sends
* a {@link RendererChangeEvent} to all registered listeners.
*
* @param visible the visibility.
* @param notify notify listeners?
*
* @see #getDefaultSeriesVisible()
*/
public void setDefaultSeriesVisible(boolean visible, boolean notify);
// SERIES VISIBLE IN LEGEND (not yet respected by all renderers)
/**
* Returns {@code true} if the series should be shown in the legend,
* and {@code false} otherwise.
*
* @param series the series index.
*
* @return A boolean.
*/
public boolean isSeriesVisibleInLegend(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
* {@link #isSeriesVisibleInLegend(int)} method.
*
* @param series the series index (zero-based).
*
* @return The flag (possibly {@code null}).
*
* @see #setSeriesVisibleInLegend(int, Boolean)
*/
public Boolean getSeriesVisibleInLegend(int series);
/**
* Sets the flag that controls whether a series is visible in the legend
* and sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param visible the flag ({@code null} permitted).
*
* @see #getSeriesVisibleInLegend(int)
*/
public void setSeriesVisibleInLegend(int series, Boolean visible);
/**
* Sets the flag that controls whether a series is visible in the legend
* and, if requested, sends a {@link RendererChangeEvent} to all registered
* listeners.
*
* @param series the series index.
* @param visible the flag ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesVisibleInLegend(int)
*/
public void setSeriesVisibleInLegend(int series, Boolean visible,
boolean notify);
/**
* Returns the default visibility in the legend for all series.
*
* @return The default visibility.
*
* @see #setDefaultSeriesVisibleInLegend(boolean)
*/
public boolean getDefaultSeriesVisibleInLegend();
/**
* Sets the default visibility in the legend and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param visible the flag.
*
* @see #getDefaultSeriesVisibleInLegend()
*/
public void setDefaultSeriesVisibleInLegend(boolean visible);
/**
* Sets the default visibility in the legend and, if requested, sends
* a {@link RendererChangeEvent} to all registered listeners.
*
* @param visible the visibility.
* @param notify notify listeners?
*
* @see #getDefaultSeriesVisibleInLegend()
*/
public void setDefaultSeriesVisibleInLegend(boolean visible, boolean notify);
//// PAINT /////////////////////////////////////////////////////////////////
/**
* Returns the paint used to fill data items as they are drawn.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The paint (never {@code null}).
*/
public Paint getItemPaint(int row, int column);
/**
* Returns the paint used to fill an item drawn by the renderer.
*
* @param series the series index (zero-based).
*
* @return The paint (possibly {@code null}).
*
* @see #setSeriesPaint(int, Paint)
*/
public Paint getSeriesPaint(int series);
/**
* Sets the paint used for a series and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param series the series index (zero-based).
* @param paint the paint ({@code null} permitted).
*
* @see #getSeriesPaint(int)
*/
public void setSeriesPaint(int series, Paint paint);
/**
* Sets the paint used for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param paint the paint ({@code null} permitted).
* @param notify notify listeners?
*/
public void setSeriesPaint(int series, Paint paint, boolean notify);
/**
* Returns the default paint. During rendering, a renderer will first look
* up the series paint and, if this is {@code null}, it will use the
* default paint.
*
* @return The default paint (never {@code null}).
*
* @see #setDefaultPaint(Paint)
*/
public Paint getDefaultPaint();
/**
* Sets the default paint and sends a {@link RendererChangeEvent} to all
* registered listeners.
*
* @param paint the paint ({@code null} not permitted).
*
* @see #getDefaultPaint()
*/
public void setDefaultPaint(Paint paint);
/**
* Sets the default paint and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultPaint()
*/
public void setDefaultPaint(Paint paint, boolean notify);
//// FILL PAINT /////////////////////////////////////////////////////////
/**
* Returns the paint used to fill data items as they are drawn.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The paint (never {@code null}).
*/
public Paint getItemFillPaint(int row, int column);
/**
* Returns the paint used to fill an item drawn by the renderer.
*
* @param series the series (zero-based index).
*
* @return The paint (possibly {@code null}).
*
* @see #setSeriesFillPaint(int, Paint)
*/
public Paint getSeriesFillPaint(int series);
/**
* Sets the paint used for a series outline and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param paint the paint ({@code null} permitted).
*
* @see #getSeriesFillPaint(int)
*/
public void setSeriesFillPaint(int series, Paint paint);
/**
* Returns the default outline paint.
*
* @return The paint (never {@code null}).
*
* @see #setDefaultFillPaint(Paint)
*/
public Paint getDefaultFillPaint();
/**
* Sets the default outline paint and sends a {@link RendererChangeEvent} to
* all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
*
* @see #getDefaultFillPaint()
*/
public void setDefaultFillPaint(Paint paint);
//// OUTLINE PAINT /////////////////////////////////////////////////////////
/**
* Returns the paint used to outline data items as they are drawn.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The paint (never {@code null}).
*/
public Paint getItemOutlinePaint(int row, int column);
/**
* Returns the paint used to outline an item drawn by the renderer.
*
* @param series the series (zero-based index).
*
* @return The paint (possibly {@code null}).
*
* @see #setSeriesOutlinePaint(int, Paint)
*/
public Paint getSeriesOutlinePaint(int series);
/**
* Sets the paint used for a series outline and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param paint the paint ({@code null} permitted).
*
* @see #getSeriesOutlinePaint(int)
*/
public void setSeriesOutlinePaint(int series, Paint paint);
/**
* Sets the paint used for a series outline and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param paint the paint ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesOutlinePaint(int)
*/
public void setSeriesOutlinePaint(int series, Paint paint, boolean notify);
/**
* Returns the default outline paint. During rendering, the renderer
* will look up the series outline paint and, if this is {@code null}, it
* will use the default outline paint.
*
* @return The paint (never {@code null}).
*
* @see #setDefaultOutlinePaint(Paint)
*/
public Paint getDefaultOutlinePaint();
/**
* Sets the default outline paint and sends a {@link RendererChangeEvent} to
* all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
*
* @see #getDefaultOutlinePaint()
*/
public void setDefaultOutlinePaint(Paint paint);
/**
* Sets the default outline paint and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultOutlinePaint()
*/
public void setDefaultOutlinePaint(Paint paint, boolean notify);
//// STROKE ////////////////////////////////////////////////////////////////
/**
* Returns the stroke used to draw data items.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The stroke (never {@code null}).
*/
public Stroke getItemStroke(int row, int column);
/**
* Returns the stroke used to draw the items in a series.
*
* @param series the series (zero-based index).
*
* @return The stroke (never {@code null}).
*
* @see #setSeriesStroke(int, Stroke)
*/
public Stroke getSeriesStroke(int series);
/**
* Sets the stroke used for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param stroke the stroke ({@code null} permitted).
*
* @see #getSeriesStroke(int)
*/
public void setSeriesStroke(int series, Stroke stroke);
/**
* Sets the stroke used for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param stroke the stroke ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesStroke(int)
*/
public void setSeriesStroke(int series, Stroke stroke, boolean notify);
/**
* Returns the default stroke.
*
* @return The default stroke (never {@code null}).
*
* @see #setDefaultStroke(Stroke)
*/
public Stroke getDefaultStroke();
/**
* Sets the default stroke and sends a {@link RendererChangeEvent} to all
* registered listeners.
*
* @param stroke the stroke ({@code null} not permitted).
*
* @see #getDefaultStroke()
*/
public void setDefaultStroke(Stroke stroke);
/**
* Sets the default stroke and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param stroke the stroke ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultStroke()
*/
public void setDefaultStroke(Stroke stroke, boolean notify);
//// OUTLINE STROKE ////////////////////////////////////////////////////////
/**
* 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.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The stroke (never {@code null}).
*/
public Stroke getItemOutlineStroke(int row, int column);
/**
* Returns the stroke used to outline the items in a series.
*
* @param series the series (zero-based index).
*
* @return The stroke (possibly {@code null}).
*
* @see #setSeriesOutlineStroke(int, Stroke)
*/
public Stroke getSeriesOutlineStroke(int series);
/**
* Sets the outline stroke used for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param stroke the stroke ({@code null} permitted).
*
* @see #getSeriesOutlineStroke(int)
*/
public void setSeriesOutlineStroke(int series, Stroke stroke);
/**
* Sets the outline stroke used for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param stroke the stroke ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesOutlineStroke(int)
*/
public void setSeriesOutlineStroke(int series, Stroke stroke, boolean notify);
/**
* Returns the default outline stroke.
*
* @return The stroke (never {@code null}).
*
* @see #setDefaultOutlineStroke(Stroke)
*/
public Stroke getDefaultOutlineStroke();
/**
* Sets the default outline stroke and sends a {@link RendererChangeEvent} to
* all registered listeners.
*
* @param stroke the stroke ({@code null} not permitted).
*
* @see #getDefaultOutlineStroke()
*/
public void setDefaultOutlineStroke(Stroke stroke);
/**
* Sets the default outline stroke and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param stroke the stroke ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultOutlineStroke()
*/
public void setDefaultOutlineStroke(Stroke stroke, boolean notify);
//// SHAPE /////////////////////////////////////////////////////////////////
/**
* Returns a shape used to represent a data item.
*
* @param row the row (or series) index (zero-based).
* @param column the column (or category) index (zero-based).
*
* @return The shape (never {@code null}).
*/
public Shape getItemShape(int row, int column);
/**
* Returns a shape used to represent the items in a series.
*
* @param series the series (zero-based index).
*
* @return The shape (possibly {@code null}).
*
* @see #setSeriesShape(int, Shape)
*/
public Shape getSeriesShape(int series);
/**
* Sets the shape used for a series and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param series the series index (zero-based).
* @param shape the shape ({@code null} permitted).
*
* @see #getSeriesShape(int)
*/
public void setSeriesShape(int series, Shape shape);
/**
* Sets the shape used for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param shape the shape ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesShape(int)
*/
public void setSeriesShape(int series, Shape shape, boolean notify);
/**
* Returns the default shape.
*
* @return The shape (never {@code null}).
*
* @see #setDefaultShape(Shape)
*/
public Shape getDefaultShape();
/**
* Sets the default shape and sends a {@link RendererChangeEvent} to all
* registered listeners.
*
* @param shape the shape ({@code null} not permitted).
*
* @see #getDefaultShape()
*/
public void setDefaultShape(Shape shape);
/**
* Sets the default shape and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param shape the shape ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultShape()
*/
public void setDefaultShape(Shape shape, boolean notify);
// ITEM LABELS VISIBLE
/**
* Returns {@code true} if an item label is visible, and
* {@code false} otherwise.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return A boolean.
*/
public boolean isItemLabelVisible(int row, int column);
/**
* Returns {@code true} if the item labels for a series are visible,
* and {@code false} otherwise.
*
* @param series the series index (zero-based).
*
* @return A boolean.
*
* @see #setSeriesItemLabelsVisible(int, Boolean)
*/
public boolean isSeriesItemLabelsVisible(int series);
/**
* Sets a flag that controls the visibility of the item labels for a series.
*
* @param series the series index (zero-based).
* @param visible the flag.
*
* @see #isSeriesItemLabelsVisible(int)
*/
public void setSeriesItemLabelsVisible(int series, boolean visible);
/**
* Sets a flag that controls the visibility of the item labels for a series.
*
* @param series the series index (zero-based).
* @param visible the flag ({@code null} permitted).
*
* @see #isSeriesItemLabelsVisible(int)
*/
public void setSeriesItemLabelsVisible(int series, Boolean visible);
/**
* Sets the visibility of item labels for a series and, if requested, sends
* a {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param visible the visible flag.
* @param notify a flag that controls whether or not listeners are
* notified.
*
* @see #isSeriesItemLabelsVisible(int)
*/
public void setSeriesItemLabelsVisible(int series, Boolean visible,
boolean notify);
/**
* Returns the default setting for item label visibility. A {@code null}
* result should be interpreted as equivalent to {@code Boolean.FALSE}
* (this is an error in the API design, the return value should have been
* a boolean primitive).
*
* @return A flag (possibly {@code null}).
*
* @see #setDefaultItemLabelsVisible(boolean)
*/
public boolean getDefaultItemLabelsVisible();
/**
* Sets the default flag that controls whether or not item labels are visible
* and sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param visible the flag.
*
* @see #getDefaultItemLabelsVisible()
*/
public void setDefaultItemLabelsVisible(boolean visible);
/**
* Sets the default visibility for item labels and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param visible the visibility flag.
* @param notify a flag that controls whether or not listeners are
* notified.
*
* @see #getDefaultItemLabelsVisible()
*/
public void setDefaultItemLabelsVisible(boolean visible, boolean notify);
// ITEM LABEL GENERATOR
/**
* Returns the item label generator for the specified data item.
*
* @param series the series index (zero-based).
* @param item the item index (zero-based).
*
* @return The generator (possibly {@code null}).
*/
public CategoryItemLabelGenerator getItemLabelGenerator(int series,
int item);
/**
* Returns the item label generator for a series.
*
* @param series the series index (zero-based).
*
* @return The label generator (possibly {@code null}).
*
* @see #setSeriesItemLabelGenerator(int, CategoryItemLabelGenerator)
*/
public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series);
/**
* Sets the item label generator for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param generator the generator.
*
* @see #getSeriesItemLabelGenerator(int)
*/
public void setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator);
/**
* Sets the item label generator for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param generator the generator.
* @param notify notify listeners?
*
* @see #getSeriesItemLabelGenerator(int)
*/
public void setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator, boolean notify);
/**
* Returns the default item label generator.
*
* @return The generator (possibly {@code null}).
*
* @see #setDefaultItemLabelGenerator(CategoryItemLabelGenerator)
*/
public CategoryItemLabelGenerator getDefaultItemLabelGenerator();
/**
* Sets the default item label generator and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the generator ({@code null} permitted).
*
* @see #getDefaultItemLabelGenerator()
*/
public void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator);
/**
* Sets the default item label generator and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the generator ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getDefaultItemLabelGenerator()
*/
public void setDefaultItemLabelGenerator(CategoryItemLabelGenerator generator,
boolean notify);
// TOOL TIP GENERATOR
/**
* 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.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The generator (possibly {@code null}).
*/
public CategoryToolTipGenerator getToolTipGenerator(int row, int column);
/**
* Returns the tool tip generator for the specified series (a "layer 1"
* generator).
*
* @param series the series index (zero-based).
*
* @return The tool tip generator (possibly {@code null}).
*
* @see #setSeriesToolTipGenerator(int, CategoryToolTipGenerator)
*/
public CategoryToolTipGenerator getSeriesToolTipGenerator(int series);
/**
* Sets the tool tip generator for a series and sends a
* {@link org.jfree.chart.event.RendererChangeEvent} to all registered
* listeners.
*
* @param series the series index (zero-based).
* @param generator the generator ({@code null} permitted).
*
* @see #getSeriesToolTipGenerator(int)
*/
public void setSeriesToolTipGenerator(int series,
CategoryToolTipGenerator generator);
/**
* Sets the tool tip generator for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param generator the generator ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesToolTipGenerator(int)
*/
public void setSeriesToolTipGenerator(int series,
CategoryToolTipGenerator generator, boolean notify);
/**
* Returns the default tool tip generator (the "layer 2" generator).
*
* @return The tool tip generator (possibly {@code null}).
*
* @see #setDefaultToolTipGenerator(CategoryToolTipGenerator)
*/
public CategoryToolTipGenerator getDefaultToolTipGenerator();
/**
* Sets the default tool tip generator and sends a
* {@link org.jfree.chart.event.RendererChangeEvent} to all registered
* listeners.
*
* @param generator the generator ({@code null} permitted).
*
* @see #getDefaultToolTipGenerator()
*/
public void setDefaultToolTipGenerator(CategoryToolTipGenerator generator);
/**
* Sets the default tool tip generator and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the generator ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getDefaultToolTipGenerator()
*/
public void setDefaultToolTipGenerator(CategoryToolTipGenerator generator,
boolean notify);
//// ITEM LABEL FONT //////////////////////////////////////////////////////
/**
* Returns the font for an item label.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The font (never {@code null}).
*/
public Font getItemLabelFont(int row, int column);
/**
* Returns the font for all the item labels in a series.
*
* @param series the series index (zero-based).
*
* @return The font (possibly {@code null}).
*
* @see #setSeriesItemLabelFont(int, Font)
*/
public Font getSeriesItemLabelFont(int series);
/**
* Sets the item label font for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param font the font ({@code null} permitted).
*
* @see #getSeriesItemLabelFont(int)
*/
public void setSeriesItemLabelFont(int series, Font font);
/**
* Sets the item label font for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param font the font ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesItemLabelFont(int)
*/
public void setSeriesItemLabelFont(int series, Font font, boolean notify);
/**
* Returns the default item label font (this is used when no other font
* setting is available).
*
* @return The font (never {@code null}).
*
* @see #setDefaultItemLabelFont(Font)
*/
public Font getDefaultItemLabelFont();
/**
* Sets the default item label font and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param font the font ({@code null} not permitted).
*
* @see #getDefaultItemLabelFont()
*/
public void setDefaultItemLabelFont(Font font);
/**
* Sets the default item label font and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param font the font ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultItemLabelFont()
*/
public void setDefaultItemLabelFont(Font font, boolean notify);
//// ITEM LABEL PAINT /////////////////////////////////////////////////////
/**
* Returns the paint used to draw an item label.
*
* @param row the row index (zero based).
* @param column the column index (zero based).
*
* @return The paint (never {@code null}).
*/
public Paint getItemLabelPaint(int row, int column);
/**
* Returns the paint used to draw the item labels for a series.
*
* @param series the series index (zero based).
*
* @return The paint (possibly {@code null}).
*
* @see #setSeriesItemLabelPaint(int, Paint)
*/
public Paint getSeriesItemLabelPaint(int series);
/**
* Sets the item label paint for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series (zero based index).
* @param paint the paint ({@code null} permitted).
*
* @see #getSeriesItemLabelPaint(int)
*/
public void setSeriesItemLabelPaint(int series, Paint paint);
/**
* Sets the item label paint for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series (zero based index).
* @param paint the paint ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesItemLabelPaint(int)
*/
public void setSeriesItemLabelPaint(int series, Paint paint, boolean notify);
/**
* Returns the default item label paint.
*
* @return The paint (never {@code null}).
*
* @see #setDefaultItemLabelPaint(Paint)
*/
public Paint getDefaultItemLabelPaint();
/**
* Sets the default item label paint and sends a {@link RendererChangeEvent}
* to all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
*
* @see #getDefaultItemLabelPaint()
*/
public void setDefaultItemLabelPaint(Paint paint);
/**
* Sets the default item label paint and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param paint the paint ({@code null} not permitted).
* @param notify notify listeners?
*
* @see #getDefaultItemLabelPaint()
*/
public void setDefaultItemLabelPaint(Paint paint, boolean notify);
// POSITIVE ITEM LABEL POSITION...
/**
* Returns the item label position for positive values.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The item label position (never {@code null}).
*/
public ItemLabelPosition getPositiveItemLabelPosition(int row, int column);
/**
* Returns the item label position for all positive values in a series.
*
* @param series the series index (zero-based).
*
* @return The item label position.
*
* @see #setSeriesPositiveItemLabelPosition(int, ItemLabelPosition)
*/
public ItemLabelPosition getSeriesPositiveItemLabelPosition(int series);
/**
* Sets the item label position for all positive values in a series and
* sends a {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param position the position ({@code null} permitted).
*
* @see #getSeriesPositiveItemLabelPosition(int)
*/
public void setSeriesPositiveItemLabelPosition(int series,
ItemLabelPosition position);
/**
* Sets the item label position for all positive values in a series and (if
* requested) sends a {@link RendererChangeEvent} to all registered
* listeners.
*
* @param series the series index (zero-based).
* @param position the position ({@code null} permitted).
* @param notify notify registered listeners?
*
* @see #getSeriesPositiveItemLabelPosition(int)
*/
public void setSeriesPositiveItemLabelPosition(int series,
ItemLabelPosition position, boolean notify);
/**
* Returns the default positive item label position.
*
* @return The position.
*
* @see #setDefaultPositiveItemLabelPosition(ItemLabelPosition)
*/
public ItemLabelPosition getDefaultPositiveItemLabelPosition();
/**
* Sets the default positive item label position.
*
* @param position the position.
*
* @see #getDefaultPositiveItemLabelPosition()
*/
public void setDefaultPositiveItemLabelPosition(ItemLabelPosition position);
/**
* Sets the default positive item label position and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param position the position.
* @param notify notify registered listeners?
*
* @see #getDefaultPositiveItemLabelPosition()
*/
public void setDefaultPositiveItemLabelPosition(ItemLabelPosition position,
boolean notify);
// NEGATIVE ITEM LABEL POSITION...
/**
* 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.
*
* @param row the row index (zero-based).
* @param column the column (zero-based).
*
* @return The item label position.
*/
public ItemLabelPosition getNegativeItemLabelPosition(int row, int column);
/**
* Returns the item label position for all negative values in a series.
*
* @param series the series index (zero-based).
*
* @return The item label position.
*
* @see #setSeriesNegativeItemLabelPosition(int, ItemLabelPosition)
*/
public ItemLabelPosition getSeriesNegativeItemLabelPosition(int series);
/**
* Sets the item label position for negative values in a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param position the position ({@code null} permitted).
*
* @see #getSeriesNegativeItemLabelPosition(int)
*/
public void setSeriesNegativeItemLabelPosition(int series,
ItemLabelPosition position);
/**
* Sets the item label position for negative values in a series and (if
* requested) sends a {@link RendererChangeEvent} to all registered
* listeners.
*
* @param series the series index (zero-based).
* @param position the position ({@code null} permitted).
* @param notify notify registered listeners?
*
* @see #getSeriesNegativeItemLabelPosition(int)
*/
public void setSeriesNegativeItemLabelPosition(int series,
ItemLabelPosition position, boolean notify);
/**
* Returns the default item label position for negative values.
*
* @return The position.
*
* @see #setDefaultNegativeItemLabelPosition(ItemLabelPosition)
*/
public ItemLabelPosition getDefaultNegativeItemLabelPosition();
/**
* Sets the default item label position for negative values and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param position the position.
*
* @see #getDefaultNegativeItemLabelPosition()
*/
public void setDefaultNegativeItemLabelPosition(ItemLabelPosition position);
/**
* Sets the default negative item label position and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param position the position.
* @param notify notify registered listeners?
*
* @see #getDefaultNegativeItemLabelPosition()
*/
public void setDefaultNegativeItemLabelPosition(ItemLabelPosition position,
boolean notify);
// CREATE ENTITIES
/**
* 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
* {@code null}, the value returned by {@link #getDefaultCreateEntities()}.
*
* @param series the series index (zero-based).
* @param item the item index (zero-based).
*
* @return A boolean.
*/
public boolean getItemCreateEntity(int series, int item);
/**
* Returns a boolean indicating whether or not entities should be created
* for the items in a series.
*
* @param series the series index (zero-based).
*
* @return The flag for the series (possibly {@code null}).
*/
public Boolean getSeriesCreateEntities(int series);
/**
* Sets a flag that indicates whether or not entities should be created during
* rendering for the items in the specified series, and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param create the new flag value ({@code null} permitted).
*/
public 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
* {@link RendererChangeEvent} to all registered listeners if requested.
*
* @param series the series index (zero-based).
* @param create the new flag value ({@code null} permitted).
* @param notify notify listeners?
*/
public void setSeriesCreateEntities(int series, Boolean create,
boolean notify);
/**
* Returns the default value for the flag that controls whether or not
* an entity is created for an item during rendering.
*
* @return A boolean.
*/
public boolean getDefaultCreateEntities();
/**
* Sets the default value for the flag that controls whether or not an
* entity is created for an item during rendering and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param create the new flag value.
*/
public 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, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param create the new flag value.
* @param notify notify listeners?
*/
public void setDefaultCreateEntities(boolean create, boolean notify);
// ITEM URL GENERATOR
/**
* Returns the URL generator for an item.
*
* @param series the series index (zero-based).
* @param item the item index (zero-based).
*
* @return The item URL generator.
*/
public CategoryURLGenerator getItemURLGenerator(int series, int item);
/**
* Returns the item URL generator for a series.
*
* @param series the series index (zero-based).
*
* @return The URL generator.
*
* @see #setSeriesItemURLGenerator(int, CategoryURLGenerator)
*/
public CategoryURLGenerator getSeriesItemURLGenerator(int series);
/**
* Sets the item URL generator for a series and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param generator the generator ({@code null} permitted).
*
* @see #getSeriesItemURLGenerator(int)
*/
public void setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator);
/**
* Sets the item URL generator for a series and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param series the series index (zero-based).
* @param generator the generator ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getSeriesItemURLGenerator(int)
*/
public void setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator, boolean notify);
/**
* Returns the default item URL generator.
*
* @return The item URL generator (possibly {@code null}).
*
* @see #setDefaultItemURLGenerator(CategoryURLGenerator)
*/
public CategoryURLGenerator getDefaultItemURLGenerator();
/**
* Sets the default item URL generator and sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the item URL generator ({@code null} permitted).
*
* @see #getDefaultItemURLGenerator()
*/
public void setDefaultItemURLGenerator(CategoryURLGenerator generator);
/**
* Sets the default item URL generator and, if requested, sends a
* {@link RendererChangeEvent} to all registered listeners.
*
* @param generator the item URL generator ({@code null} permitted).
* @param notify notify listeners?
*
* @see #getDefaultItemURLGenerator()
*/
public void setDefaultItemURLGenerator(CategoryURLGenerator generator, boolean notify);
/**
* Returns a legend item for a series. This method can return
* {@code null}, in which case the series will have no entry in the
* legend.
*
* @param datasetIndex the dataset index (zero-based).
* @param series the series (zero-based index).
*
* @return The legend item (possibly {@code null}).
*/
public LegendItem getLegendItem(int datasetIndex, int series);
/**
* Draws a background for the data area.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param dataArea the data area.
*/
public void drawBackground(Graphics2D g2, CategoryPlot plot,
Rectangle2D dataArea);
/**
* Draws an outline for the data area.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param dataArea the data area.
*/
public void drawOutline(Graphics2D g2, CategoryPlot plot,
Rectangle2D dataArea);
/**
* Draws a single data item.
*
* @param g2 the graphics device.
* @param state state information for one chart.
* @param dataArea the data plot area.
* @param plot the plot.
* @param domainAxis the domain axis.
* @param rangeAxis the range axis.
* @param dataset the data.
* @param row the row index (zero-based).
* @param column the column index (zero-based).
* @param pass the pass index.
*/
public void drawItem(Graphics2D g2, CategoryItemRendererState state,
Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis,
ValueAxis rangeAxis, CategoryDataset dataset, int row, int column,
int pass);
/**
* Draws a grid line against the domain axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param dataArea the area for plotting data.
* @param value the value.
*/
public void drawDomainGridline(Graphics2D g2, CategoryPlot plot,
Rectangle2D dataArea, double value);
/**
* Draws a grid line against the range axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param dataArea the area for plotting data.
* @param value the value.
* @param paint the paint ({@code null} not permitted).
* @param stroke the line stroke ({@code null} not permitted).
*/
public void drawRangeLine(Graphics2D g2, CategoryPlot plot, ValueAxis axis,
Rectangle2D dataArea, double value, Paint paint, Stroke stroke);
/**
* Draws a line (or some other marker) to indicate a particular category on
* the domain axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the category axis.
* @param marker the marker.
* @param dataArea the area for plotting data.
*
* @see #drawRangeMarker(Graphics2D, CategoryPlot, ValueAxis, Marker,
* Rectangle2D)
*/
public void drawDomainMarker(Graphics2D g2, CategoryPlot plot,
CategoryAxis axis, CategoryMarker marker, Rectangle2D dataArea);
/**
* Draws a line (or some other marker) to indicate a particular value on
* the range axis.
*
* @param g2 the graphics device.
* @param plot the plot.
* @param axis the value axis.
* @param marker the marker.
* @param dataArea the area for plotting data.
*
* @see #drawDomainMarker(Graphics2D, CategoryPlot, CategoryAxis,
* CategoryMarker, Rectangle2D)
*/
public void drawRangeMarker(Graphics2D g2, CategoryPlot plot,
ValueAxis axis, Marker marker, Rectangle2D dataArea);
/**
* Returns the Java2D coordinate for the middle of the specified data item.
*
* @param rowKey the row key.
* @param columnKey the column key.
* @param dataset the dataset.
* @param axis the axis.
* @param area the data area.
* @param edge the edge along which the axis lies.
*
* @return The Java2D coordinate for the middle of the item.
*
* @since 1.0.11
*/
public double getItemMiddle(Comparable rowKey, Comparable columnKey,
CategoryDataset dataset, CategoryAxis axis, Rectangle2D area,
RectangleEdge edge);
}