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     * Changes:
036     * --------
037     * 07-Oct-2003 : Version 1 (DG);
038     * 27-Jan-2004 : Added workingLine attribute (DG);
039     * ------------- JFREECHART 1.0.x ---------------------------------------------
040     * 04-May-2007 : Added processVisibleItemsOnly flag (DG);
041     * 
042     */
043    
044    package org.jfree.chart.renderer.xy;
045    
046    import java.awt.geom.Line2D;
047    
048    import org.jfree.chart.plot.PlotRenderingInfo;
049    import org.jfree.chart.renderer.RendererState;
050    
051    /**
052     * The state for an {@link XYItemRenderer}.
053     */
054    public class XYItemRendererState extends RendererState {
055    
056        /** 
057         * A line object that the renderer can reuse to save instantiating a lot 
058         * of objects. 
059         */
060        public Line2D workingLine;
061        
062        /** 
063         * A flag that controls whether the plot should pass ALL data items to the
064         * renderer, or just the items that will be visible.
065         * 
066         * @since 1.0.6
067         */
068        private boolean processVisibleItemsOnly;
069        
070        /**
071         * Creates a new state.
072         * 
073         * @param info  the plot rendering info.
074         */
075        public XYItemRendererState(PlotRenderingInfo info) {
076            super(info);
077            this.workingLine = new Line2D.Double();
078            this.processVisibleItemsOnly = true;
079        }
080    
081        /**
082         * Returns the flag that controls whether the plot passes all data
083         * items in each series to the renderer, or just the visible items.  The
084         * default value is <code>true</code>.
085         * 
086         * @return A boolean.
087         * 
088         * @since 1.0.6
089         * 
090         * @see #setProcessVisibleItemsOnly(boolean)
091         */
092        public boolean getProcessVisibleItemsOnly() {
093            return this.processVisibleItemsOnly;
094        }
095        
096        /**
097         * Sets the flag that controls whether the plot passes all data
098         * items in each series to the renderer, or just the visible items.
099         * 
100         * @param flag  the new flag value.
101         * 
102         * @since 1.0.6
103         */
104        public void setProcessVisibleItemsOnly(boolean flag) {
105            this.processVisibleItemsOnly = flag;
106        }
107       
108    }