/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, 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., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * -------------------

 * XYItemRenderer.java

 * -------------------

 * (C) Copyright 2001-2004, by Object Refinery Limited and Contributors.

 *

 * Original Author:  David Gilbert (for Object Refinery Limited);

 * Contributor(s):   Mark Watson (www.markwatson.com);

 *                   Sylvain Vieujot;

 *                   Focus Computer Services Limited;

 *                   Richard Atkinson;

 *

 * $Id: XYItemRenderer.java,v 1.2 2004/09/10 13:54:08 mungady Exp $

 *

 * Changes

 * -------

 * 19-Oct-2001 : Version 1, based on code by Mark Watson (DG);

 * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc. (DG);

 * 13-Dec-2001 : Changed return type of drawItem from void --> Shape.  The area returned can

 *               be used as the tooltip region.

 * 23-Jan-2002 : Added DrawInfo parameter to drawItem(...) method (DG);

 * 28-Mar-2002 : Added a property change listener mechanism.  Now renderers do not have to be

 *               immutable (DG);

 * 04-Apr-2002 : Added the initialise(...) method (DG);

 * 09-Apr-2002 : Removed the translated zero from the drawItem method, it can be calculated inside

 *               the initialise method if it is required.  Added a new getToolTipGenerator()

 *               method.  Changed the return type for drawItem() to void (DG);

 * 24-May-2002 : Added ChartRenderingInfo the initialise method API (DG);

 * 25-Jun-2002 : Removed redundant import (DG);

 * 20-Aug-2002 : Added get/setURLGenerator methods to interface (DG);

 * 02-Oct-2002 : Fixed errors reported by Checkstyle (DG);

 * 18-Nov-2002 : Added methods for drawing grid lines (DG);

 * 17-Jan-2003 : Moved plot classes into a separate package (DG);

 * 27-Jan-2003 : Added shape lookup table (DG);

 * 05-Jun-2003 : Added domain and range grid bands (sponsored by Focus Computer Services Ltd) (DG);

 * 27-Jul-2003 : Added getRangeType() to support stacked XY area charts (RA);

 * 16-Sep-2003 : Changed ChartRenderingInfo --> PlotRenderingInfo (DG);

 * 25-Feb-2004 : Replaced CrosshairInfo with CrosshairState.  Renamed XYToolTipGenerator

 *               --> XYItemLabelGenerator (DG);

 * 26-Feb-2004 : Added lots of new methods (DG);

 * 30-Apr-2004 : Added getRangeExtent() method (DG);

 * 06-May-2004 : Added methods for controlling item label visibility (DG);

 * 13-May-2004 : Removed property change listener mechanism (DG);

 * 18-May-2004 : Added item label font and paint methods (DG);

 * 10-Sep-2004 : Removed redundant getRangeType() method (DG);

 *

 */



package org.jfree.chart.renderer.xy;



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.axis.ValueAxis;

import org.jfree.chart.event.RendererChangeEvent;

import org.jfree.chart.event.RendererChangeListener;

import org.jfree.chart.labels.ItemLabelPosition;

import org.jfree.chart.labels.XYLabelGenerator;

import org.jfree.chart.labels.XYToolTipGenerator;

import org.jfree.chart.plot.CrosshairState;

import org.jfree.chart.plot.Marker;

import org.jfree.chart.plot.PlotRenderingInfo;

import org.jfree.chart.plot.XYPlot;

import org.jfree.chart.urls.XYURLGenerator;

import org.jfree.data.Range;

import org.jfree.data.xy.XYDataset;



/**

 * Interface for rendering the visual representation of a single (x, y) item on an

 * {@link XYPlot}.

 * <p>

 * To support cloning charts, it is recommended that renderers implement both the {@link Cloneable} 

 * and <code>PublicCloneable</code> interfaces.

 * 

 */

public interface XYItemRenderer {



    /**

     * Initialises the renderer then returns the number of 'passes' through the data that the

     * renderer will require (usually just one).  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 dataset  the dataset.

     * @param info  an optional info collection object to return data back to the caller.

     *

     * @return The number of passes the renderer requires.

     */

    public XYItemRendererState initialise(Graphics2D g2,

                                          Rectangle2D dataArea,

                                          XYPlot plot,

                                          XYDataset dataset,

                                          PlotRenderingInfo info);



    /**

     * Returns the number of passes through the data required by the renderer.

     * 

     * @return The pass count.

     */

    public int getPassCount();



    /**

     * 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 the flag that controls the visibility of ALL series.  This flag overrides the

     * per series and default settings - you must set it to <code>null</code> if you want the

     * other settings to apply.

     * 

     * @return The flag (possibly <code>null</code>).

     */

    public Boolean getSeriesVisible();

    

    /**

     * Sets the flag that controls the visibility of ALL series and sends a 

     * {@link RendererChangeEvent} to all registered listeners.  This flag overrides the

     * per series and default settings - you must set it to <code>null</code> if you want the

     * other settings to apply.

     * 

     * @param visible  the flag (<code>null</code> permitted).

     */

    public void setSeriesVisible(Boolean visible);

    

    /**

     * Sets the flag that controls the visibility of ALL series and sends a 

     * {@link RendererChangeEvent} to all registered listeners.  This flag overrides the

     * per series and default settings - you must set it to <code>null</code> if you want the

     * other settings to apply.

     * 

     * @param visible  the flag (<code>null</code> permitted).

     * @param notify  notify listeners?

     */

    public void setSeriesVisible(Boolean visible, boolean notify);

    

    /**

     * Returns the flag that controls whether a series is visible.

     *

     * @param series  the series index (zero-based).

     *

     * @return The flag (possibly <code>null</code>).

     */

    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</code> permitted).

     */

    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</code> permitted).

     * @param notify  notify listeners?

     */

    public void setSeriesVisible(int series, Boolean visible, boolean notify);



    /**

     * Returns the base visibility for all series.

     *

     * @return The base visibility.

     */

    public boolean getBaseSeriesVisible();



    /**

     * Sets the base visibility and sends a {@link RendererChangeEvent} to all registered listeners.

     *

     * @param visible  the flag.

     */

    public void setBaseSeriesVisible(boolean visible);

    

    /**

     * Sets the base visibility and, if requested, sends a {@link RendererChangeEvent} to all registered

     * listeners.

     * 

     * @param visible  the visibility.

     * @param notify  notify listeners?

     */

    public void setBaseSeriesVisible(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</code>).

     */

    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 (never <code>null</code>).

     */

    public Paint getSeriesPaint(int series);



    /**

     * Sets the paint to be used for ALL series, and sends a {@link RendererChangeEvent} to all

     * registered listeners.  If this is <code>null</code>, the renderer will use the paint for 

     * the series.

     * 

     * @param paint  the paint (<code>null</code> permitted).

     */

    public void setPaint(Paint paint);

    

    /**

     * 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</code> permitted).

     */

    public void setSeriesPaint(int series, Paint paint);

    

    /**

     * Returns the base paint.

     *

     * @return the base paint (never <code>null</code>).

     */

    public Paint getBasePaint();



    /**

     * Sets the base paint and sends a {@link RendererChangeEvent} to all registered listeners.

     *

     * @param paint  the paint (<code>null</code> not permitted).

     */

    public void setBasePaint(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</code>).

     */

    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 (never <code>null</code>).

     */

    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</code> permitted).

     */

    public void setSeriesOutlinePaint(int series, Paint paint);



    /**

     * Sets the outline paint for ALL series (optional).

     * 

     * @param paint  the paint (<code>null</code> permitted).

     */

    public void setOutlinePaint(Paint paint);

    

    /**

     * Returns the base outline paint.

     *

     * @return the paint (never <code>null</code>).

     */

    public Paint getBaseOutlinePaint();



    /**

     * Sets the base outline paint and sends a {@link RendererChangeEvent} to all 

     * registered listeners.

     *

     * @param paint  the paint (<code>null</code> not permitted).

     */

    public void setBaseOutlinePaint(Paint paint);



    // 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</code>).

     */

    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</code>).

     */

    public Stroke getSeriesStroke(int series);

    

    /**

     * Sets the stroke for ALL series and sends a {@link RendererChangeEvent} to all

     * registered listeners.

     * 

     * @param stroke  the stroke (<code>null</code> permitted).

     */

    public void setStroke(Stroke stroke);



    /**

     * 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</code> permitted).

     */

    public void setSeriesStroke(int series, Stroke stroke);



    /**

     * Returns the base stroke.

     *

     * @return the base stroke (never <code>null</code>).

     */

    public Stroke getBaseStroke();



    /**

     * Sets the base stroke.

     *

     * @param stroke  the stroke (<code>null</code> not permitted).

     */

    public void setBaseStroke(Stroke stroke);

    

    // OUTLINE STROKE 

    

    /**

     * Returns the stroke used to outline data items.

     * <p>

     * The default implementation passes control to the getSeriesOutlineStroke 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</code>).

     */

    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 (never <code>null</code>).

     */

    public Stroke getSeriesOutlineStroke(int series);



    /**

     * Sets the outline stroke for ALL series and sends a {@link RendererChangeEvent} to

     * all registered listeners.

     *

     * @param stroke  the stroke (<code>null</code> permitted).

     */

    public void setOutlineStroke(Stroke stroke);

    

    /**

     * 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</code> permitted).

     */

    public void setSeriesOutlineStroke(int series, Stroke stroke);

    

    /**

     * Returns the base outline stroke.

     *

     * @return the stroke (never <code>null</code>).

     */

    public Stroke getBaseOutlineStroke();



    /**

     * Sets the base outline stroke and sends a {@link RendererChangeEvent} to all 

     * registered listeners.

     *

     * @param stroke  the stroke (<code>null</code> not permitted).

     */

    public void setBaseOutlineStroke(Stroke stroke);

    

    // 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</code>).

     */

    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 (never <code>null</code>).

     */

    public Shape getSeriesShape(int series);

    /**

     * Sets the shape for ALL series (optional) and sends a {@link RendererChangeEvent} 

     * to all registered listeners.

     * 

     * @param shape  the shape (<code>null</code> permitted).

     */

    public void setShape(Shape shape);

    

    /**

     * 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</code> permitted).

     */

    public void setSeriesShape(int series, Shape shape);

    

    /**

     * Returns the base shape.

     *

     * @return the shape (never <code>null</code>).

     */

    public Shape getBaseShape();



    /**

     * Sets the base shape and sends a {@link RendererChangeEvent} to all 

     * registered listeners.

     *

     * @param shape  the shape (<code>null</code> not permitted).

     */

    public void setBaseShape(Shape shape);

    

    // ITEM LABELS VISIBLE 

    

    /**

     * Returns <code>true</code> if an item label is visible, and <code>false</code> 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</code> if the item labels for a series are visible, and 

     * <code>false</code> otherwise.

     * 

     * @param series  the series index (zero-based).

     * 

     * @return a boolean.

     */    

    public boolean isSeriesItemLabelsVisible(int series);

    

    /**

     * Sets a flag that controls whether or not the item labels for ALL series are visible.

     * 

     * @param visible  the flag.

     */

    public void setItemLabelsVisible(boolean visible);



    /**

     * Sets a flag that controls whether or not the item labels for ALL series are visible.

     * 

     * @param visible  the flag (<code>null</code> permitted).

     */

    public void setItemLabelsVisible(Boolean visible);



    /**

     * Sets the visibility of item labels for ALL series and, if requested, sends a 

     * {@link RendererChangeEvent} to all registered listeners.

     * 

     * @param visible  a flag that controls whether or not the item labels are visible 

     *                 (<code>null</code> permitted).

     * @param notify  a flag that controls whether or not listeners are notified.

     */

    public void setItemLabelsVisible(Boolean visible, boolean notify);



    /**

     * 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.

     */

    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</code> permitted).

     */

    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.

     */

    public void setSeriesItemLabelsVisible(int series, Boolean visible, boolean notify);

    

    /**

     * Returns the base setting for item label visibility.

     * 

     * @return A flag (possibly <code>null</code>).

     */

    public Boolean getBaseItemLabelsVisible();

    

    /**

     * Sets the base flag that controls whether or not item labels are visible.

     * 

     * @param visible  the flag.

     */

    public void setBaseItemLabelsVisible(boolean visible);

    

    /**

     * Sets the base setting for item label visibility.

     * 

     * @param visible  the flag (<code>null</code> permitted).

     */

    public void setBaseItemLabelsVisible(Boolean visible);

    

    /**

     * Sets the base 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.

     */

    public void setBaseItemLabelsVisible(Boolean visible, boolean notify);



    // LABEL GENERATOR



    /**

     * Returns the label generator for a data item.

     *

     * @param row  the row index (zero based).

     * @param column  the column index (zero based).

     *

     * @return the generator (possibly <code>null</code>).

     */

    public XYLabelGenerator getLabelGenerator(int row, int column);

    

    /**

     * Returns the label generator for a series.

     *

     * @param series  the series index (zero based).

     *

     * @return the generator (possibly <code>null</code>).

     */

    public XYLabelGenerator getSeriesLabelGenerator(int series);



    /**

     * Sets the item label generator for ALL series and sends a {@link RendererChangeEvent}

     * to all registered listeners.

     *

     * @param generator  the generator (<code>null</code> permitted).

     */

    public void setLabelGenerator(XYLabelGenerator generator);



    /**

     * Sets the 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 (<code>null</code> permitted).

     */

    public void setSeriesLabelGenerator(int series, XYLabelGenerator generator);



    /**

     * Returns the base item label generator.

     *

     * @return the generator (possibly <code>null</code>).

     */

    public XYLabelGenerator getBaseLabelGenerator();



    /**

     * Sets the base item label generator and sends a {@link RendererChangeEvent}

     * to all registered listeners.

     *

     * @param generator  the generator (<code>null</code> permitted).

     */

    public void setBaseLabelGenerator(XYLabelGenerator generator);



    // TOOL TIP GENERATOR



    /**

     * Returns the tool tip generator for a data item.

     *

     * @param row  the row index (zero based).

     * @param column  the column index (zero based).

     *

     * @return The generator (possibly <code>null</code>).

     */

    public XYToolTipGenerator getToolTipGenerator(int row, int column);

    

    /**

     * Returns the tool tip generator for a series.

     *

     * @param series  the series index (zero based).

     *

     * @return The generator (possibly <code>null</code>).

     */

    public XYToolTipGenerator getSeriesToolTipGenerator(int series);



    /**

     * Sets the tool tip generator for ALL series and sends a {@link RendererChangeEvent}

     * to all registered listeners.

     *

     * @param generator  the generator (<code>null</code> permitted).

     */

    public void setToolTipGenerator(XYToolTipGenerator generator);



    /**

     * Sets the tool tip 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</code> permitted).

     */

    public void setSeriesToolTipGenerator(int series, XYToolTipGenerator generator);



    /**

     * Returns the base tool tip generator.

     *

     * @return the generator (possibly <code>null</code>).

     */

    public XYToolTipGenerator getBaseToolTipGenerator();



    /**

     * Sets the base tool tip generator and sends a {@link RendererChangeEvent}

     * to all registered listeners.

     *

     * @param generator  the generator (<code>null</code> permitted).

     */

    public void setBaseToolTipGenerator(XYToolTipGenerator generator);



    // URL GENERATOR

    

    /**

     * Returns the URL generator for HTML image maps.

     *

     * @return the URL generator (possibly null).

     */

    public XYURLGenerator getURLGenerator();



    /**

     * Sets the URL generator for HTML image maps.

     *

     * @param urlGenerator the URL generator (null permitted).

     */

    public void setURLGenerator(XYURLGenerator urlGenerator);



    //// 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</code>).

     */

    public Font getItemLabelFont(int row, int column);



    /**

     * Returns the font used for all item labels.  This may be <code>null</code>, in which case 

     * the per series font settings will apply.

     * 

     * @return The font (possibly <code>null</code>).

     */

    public Font getItemLabelFont();

    

    /**

     * Sets the item label font for ALL series and sends a {@link RendererChangeEvent} to all

     * registered listeners.  You can set this to <code>null</code> if you prefer to set the font

     * on a per series basis.

     * 

     * @param font  the font (<code>null</code> permitted).

     */

    public void setItemLabelFont(Font font);

    

    /**

     * Returns the font for all the item labels in a series.

     * 

     * @param series  the series index (zero-based).

     * 

     * @return The font (possibly <code>null</code>).

     */

    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</code> permitted).

     */

    public void setSeriesItemLabelFont(int series, Font font);



    /**

     * Returns the base item label font (this is used when no other font setting is available).

     * 

     * @return The font (<code>never</code> null).

     */

    public Font getBaseItemLabelFont();



    /**

     * Sets the base item label font and sends a {@link RendererChangeEvent} to all

     * registered listeners.  

     * 

     * @param font  the font (<code>null</code> not permitted).

     */

    public void setBaseItemLabelFont(Font font);



    //// 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</code>).

     */

    public Paint getItemLabelPaint(int row, int column);

    

    /**

     * Returns the paint used for all item labels.  This may be <code>null</code>, in which case 

     * the per series paint settings will apply.

     * 

     * @return The paint (possibly <code>null</code>).

     */

    public Paint getItemLabelPaint();



    /**

     * Sets the item label paint for ALL series and sends a {@link RendererChangeEvent} to all

     * registered listeners.

     * 

     * @param paint  the paint (<code>null</code> permitted).

     */

    public void setItemLabelPaint(Paint paint);

    

    /**

     * 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<code>).

     */

    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</code> permitted).

     */

    public void setSeriesItemLabelPaint(int series, Paint paint);

        

    /**

     * Returns the base item label paint.

     * 

     * @return The paint (never <code>null<code>).

     */

    public Paint getBaseItemLabelPaint();



    /**

     * Sets the base item label paint and sends a {@link RendererChangeEvent} to all

     * registered listeners.

     * 

     * @param paint  the paint (<code>null</code> not permitted).

     */

    public void setBaseItemLabelPaint(Paint paint);

    

    // 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</code>).

     */

    public ItemLabelPosition getPositiveItemLabelPosition(int row, int column);



    /**

     * Returns the item label position for positive values in ALL series.

     * 

     * @return the item label position (possibly <code>null</code>).

     */

    public ItemLabelPosition getPositiveItemLabelPosition();



    /**

     * Sets the item label position for positive values in ALL series, and sends a 

     * {@link RendererChangeEvent} to all registered listeners.  You need to set this to

     * <code>null</code> to expose the settings for individual series.

     * 

     * @param position  the position (<code>null</code> permitted).

     */

    public void setPositiveItemLabelPosition(ItemLabelPosition position);

    

    /**

     * Sets the positive item label position for ALL series and (if requested) sends a 

     * {@link RendererChangeEvent} to all registered listeners.

     * 

     * @param position  the position (<code>null</code> permitted).

     * @param notify  notify registered listeners?

     */

    public void setPositiveItemLabelPosition(ItemLabelPosition position, boolean notify);



    /**

     * Returns the item label position for all positive values in a series.

     * 

     * @param series  the series index (zero-based).

     * 

     * @return the item label position (never <code>null</code>).

     */

    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</code> permitted).

     */

    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</code> permitted).

     * @param notify  notify registered listeners?

     */

    public void setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position, 

                                                   boolean notify);



    /**

     * Returns the base positive item label position.

     * 

     * @return the position (never <code>null</code>).

     */

    public ItemLabelPosition getBasePositiveItemLabelPosition();



    /**

     * Sets the base positive item label position.

     * 

     * @param position  the position (<code>null</code> not permitted).

     */

    public void setBasePositiveItemLabelPosition(ItemLabelPosition position);

    

    /**

     * Sets the base positive item label position and, if requested, sends a 

     * {@link RendererChangeEvent} to all registered listeners.

     * 

     * @param position  the position (<code>null</code> not permitted).

     * @param notify  notify registered listeners?

     */

    public void setBasePositiveItemLabelPosition(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 (never <code>null</code>).

     */

    public ItemLabelPosition getNegativeItemLabelPosition(int row, int column);



    /**

     * Returns the item label position for negative values in ALL series.

     * 

     * @return the item label position (possibly <code>null</code>).

     */

    public ItemLabelPosition getNegativeItemLabelPosition();



    /**

     * Sets the item label position for negative values in ALL series, and sends a 

     * {@link RendererChangeEvent} to all registered listeners.  You need to set this to

     * <code>null</code> to expose the settings for individual series.

     * 

     * @param position  the position (<code>null</code> permitted).

     */

    public void setNegativeItemLabelPosition(ItemLabelPosition position);

    

    /**

     * Sets the item label position for negative values in ALL series and (if requested) sends 

     * a {@link RendererChangeEvent} to all registered listeners.  

     * 

     * @param position  the position (<code>null</code> permitted).

     * @param notify  notify registered listeners?

     */

    public void setNegativeItemLabelPosition(ItemLabelPosition position, boolean notify);



    /**

     * Returns the item label position for all negative values in a series.

     * 

     * @param series  the series index (zero-based).

     * 

     * @return the item label position (never <code>null</code>).

     */

    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</code> permitted).

     */

    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</code> permitted).

     * @param notify  notify registered listeners?

     */

    public void setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position, 

                                                   boolean notify);



    /**

     * Returns the base item label position for negative values.

     * 

     * @return the position (never <code>null</code>).

     */

    public ItemLabelPosition getBaseNegativeItemLabelPosition();



    /**

     * Sets the base item label position for negative values and sends a 

     * {@link RendererChangeEvent} to all registered listeners.

     * 

     * @param position  the position (<code>null</code> not permitted).

     */

    public void setBaseNegativeItemLabelPosition(ItemLabelPosition position);

    

    /**

     * Sets the base negative item label position and, if requested, sends a 

     * {@link RendererChangeEvent} to all registered listeners.

     * 

     * @param position  the position (<code>null</code> not permitted).

     * @param notify  notify registered listeners?

     */

    public void setBaseNegativeItemLabelPosition(ItemLabelPosition position, boolean notify);



    /**

     * Called for each item to be plotted.

     * <p>

     * The {@link XYPlot} can make multiple passes through the dataset, depending on the value

     * returned by the renderer's initialise() method.

     *

     * @param g2  the graphics device.

     * @param state  the renderer state.

     * @param dataArea  the area within which the data is being rendered.

     * @param info  collects drawing info.

     * @param plot  the plot (can be used to obtain standard color information etc).

     * @param domainAxis  the domain axis.

     * @param rangeAxis  the range axis.

     * @param dataset  the dataset.

     * @param series  the series index (zero-based).

     * @param item  the item index (zero-based).

     * @param crosshairState  crosshair information for the plot (<code>null</code> permitted).

     * @param pass  the pass index.

     */

    public void drawItem(Graphics2D g2,

                         XYItemRendererState state,

                         Rectangle2D dataArea,

                         PlotRenderingInfo info,

                         XYPlot plot,

                         ValueAxis domainAxis,

                         ValueAxis rangeAxis,

                         XYDataset dataset,

                         int series,

                         int item,

                         CrosshairState crosshairState,

                         int pass);



    /**

     * Returns a legend item for a series from a dataset.

     *

     * @param datasetIndex  the dataset index.

     * @param series  the series (zero-based index).

     *

     * @return The legend item (possibly <code>null</code>).

     */

    public LegendItem getLegendItem(int datasetIndex, int series);



    /**

     * Fills a band between two values on the axis.  This can be used to color bands between the

     * grid lines.

     *

     * @param g2  the graphics device.

     * @param plot  the plot.

     * @param axis  the domain axis.

     * @param dataArea  the data area.

     * @param start  the start value.

     * @param end  the end value.

     */

    public void fillDomainGridBand(Graphics2D g2,

                                   XYPlot plot,

                                   ValueAxis axis,

                                   Rectangle2D dataArea,

                                   double start, double end);



    /**

     * Fills a band between two values on the range axis.  This can be used to color bands between

     * the grid lines.

     *

     * @param g2  the graphics device.

     * @param plot  the plot.

     * @param axis  the range axis.

     * @param dataArea  the data area.

     * @param start  the start value.

     * @param end  the end value.

     */

    public void fillRangeGridBand(Graphics2D g2,

                                  XYPlot plot,

                                  ValueAxis axis,

                                  Rectangle2D dataArea,

                                  double start, double end);



    /**

     * Draws a grid line against the domain axis.

     *

     * @param g2  the graphics device.

     * @param plot  the plot.

     * @param axis  the value axis.

     * @param dataArea  the area for plotting data (not yet adjusted for any 3D effect).

     * @param value  the value.

     */

    public void drawDomainGridLine(Graphics2D g2,

                                   XYPlot plot,

                                   ValueAxis axis,

                                   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 (not yet adjusted for any 3D effect).

     * @param value  the value.

     */

    public void drawRangeGridLine(Graphics2D g2,

                                  XYPlot plot,

                                  ValueAxis axis,

                                  Rectangle2D dataArea,

                                  double value);



    /**

     * Draws a vertical line on the chart to represent a 'range marker'.

     *

     * @param g2  the graphics device.

     * @param plot  the plot.

     * @param axis  the value axis.

     * @param marker  the marker line.

     * @param dataArea  the axis data area.

     */

    public void drawDomainMarker(Graphics2D g2,

                                 XYPlot plot,

                                 ValueAxis axis,

                                 Marker marker,

                                 Rectangle2D dataArea);



    /**

     * Draws a horizontal line across the chart to represent a 'range marker'.

     *

     * @param g2  the graphics device.

     * @param plot  the plot.

     * @param axis  the value axis.

     * @param marker  the marker line.

     * @param dataArea  the axis data area.

     */

    public void drawRangeMarker(Graphics2D g2,

                                XYPlot plot,

                                ValueAxis axis,

                                Marker marker,

                                Rectangle2D dataArea);



    /**

     * Returns the plot that this renderer has been assigned to.

     *

     * @return the plot.

     */

    public XYPlot getPlot();



    /**

     * Sets the plot that this renderer is assigned to.

     * <P>

     * This method will be called by the plot class...you do not need to call it yourself.

     *

     * @param plot  the plot.

     */

    public void setPlot(XYPlot plot);

    

    /**

     * Returns the range of values the renderer requires to display all the items from the

     * specified dataset.

     * 

     * @param dataset  the dataset (<code>null</code> permitted).

     * 

     * @return The range (or <code>null</code> if the dataset is <code>null</code> or empty).

     */

    public Range getRangeExtent(XYDataset dataset);

    

    /**

     * Add a renderer change listener.

     * 

     * @param listener  the listener.

     */

    public void addChangeListener(RendererChangeListener listener);



    /**

     * Removes a change listener.

     * 

     * @param listener  the listener.

     */

    public void removeChangeListener(RendererChangeListener listener);



}

