001    /* ===========================================================
002     * JFreeChart : a free chart library for the Java(tm) platform
003     * ===========================================================
004     *
005     * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006     *
007     * Project Info:  http://www.jfree.org/jfreechart/index.html
008     *
009     * This library is free software; you can redistribute it and/or modify it 
010     * under the terms of the GNU Lesser General Public License as published by 
011     * the Free Software Foundation; either version 2.1 of the License, or 
012     * (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but 
015     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
016     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
017     * License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this library; if not, write to the Free Software
021     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
022     * USA.  
023     *
024     * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025     * in the United States and other countries.]
026     *
027     * ------------------------
028     * XYItemRendererState.java
029     * ------------------------
030     * (C) Copyright 2003-2007, by Object Refinery Limited.
031     *
032     * Original Author:  David Gilbert (for Object Refinery Limited);
033     * Contributor(s):   -;
034     *
035     * $Id: XYItemRendererState.java,v 1.2.2.2 2007/05/04 11:12:16 mungady Exp $
036     *
037     * Changes:
038     * --------
039     * 07-Oct-2003 : Version 1 (DG);
040     * 27-Jan-2004 : Added workingLine attribute (DG);
041     * ------------- JFREECHART 1.0.x ---------------------------------------------
042     * 04-May-2007 : Added processVisibleItemsOnly flag (DG);
043     * 
044     */
045    
046    package org.jfree.chart.renderer.xy;
047    
048    import java.awt.geom.Line2D;
049    
050    import org.jfree.chart.plot.PlotRenderingInfo;
051    import org.jfree.chart.renderer.RendererState;
052    
053    /**
054     * The state for an {@link XYItemRenderer}.
055     */
056    public class XYItemRendererState extends RendererState {
057    
058        /** 
059         * A line object that the renderer can reuse to save instantiating a lot 
060         * of objects. 
061         */
062        public Line2D workingLine;
063        
064        /** 
065         * A flag that controls whether the plot should pass ALL data items to the
066         * renderer, or just the items that will be visible.
067         * 
068         * @since 1.0.6
069         */
070        private boolean processVisibleItemsOnly;
071        
072        /**
073         * Creates a new state.
074         * 
075         * @param info  the plot rendering info.
076         */
077        public XYItemRendererState(PlotRenderingInfo info) {
078            super(info);
079            this.workingLine = new Line2D.Double();
080            this.processVisibleItemsOnly = true;
081        }
082    
083        /**
084         * Returns the flag that controls whether the plot passes all data
085         * items in each series to the renderer, or just the visible items.  The
086         * default value is <code>true</code>.
087         * 
088         * @return A boolean.
089         * 
090         * @since 1.0.6
091         * 
092         * @see #setProcessVisibleItemsOnly(boolean)
093         */
094        public boolean getProcessVisibleItemsOnly() {
095            return this.processVisibleItemsOnly;
096        }
097        
098        /**
099         * Sets the flag that controls whether the plot passes all data
100         * items in each series to the renderer, or just the visible items.
101         * 
102         * @param flag  the new flag value.
103         * 
104         * @since 1.0.6
105         */
106        public void setProcessVisibleItemsOnly(boolean flag) {
107            this.processVisibleItemsOnly = flag;
108        }
109       
110    }