Source for org.jfree.chart.renderer.category.CategoryItemRendererState

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ------------------------------
  28:  * CategoryItemRendererState.java
  29:  * ------------------------------
  30:  * (C) Copyright 2003, 2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: CategoryItemRendererState.java,v 1.2.2.1 2005/10/25 20:54:16 mungady Exp $
  36:  *
  37:  * Changes (since 20-Oct-2003):
  38:  * ----------------------------
  39:  * 20-Oct-2003 : Added series running total (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.renderer.category;
  44: 
  45: import org.jfree.chart.plot.PlotRenderingInfo;
  46: import org.jfree.chart.renderer.RendererState;
  47: 
  48: /**
  49:  * An object that retains temporary state information for a 
  50:  * {@link CategoryItemRenderer}.
  51:  */
  52: public class CategoryItemRendererState extends RendererState {
  53: 
  54:     /** The bar width. */
  55:     private double barWidth;
  56:     
  57:     /** The series running total. */
  58:     private double seriesRunningTotal;
  59:     
  60:     /**
  61:      * Creates a new object for recording temporary state information for a
  62:      * renderer.
  63:      * 
  64:      * @param info  the plot rendering info.
  65:      */
  66:     public CategoryItemRendererState(PlotRenderingInfo info) {
  67:         super(info);
  68:         this.barWidth = 0.0;
  69:         this.seriesRunningTotal = 0.0;
  70:     }
  71:     
  72:     /**
  73:      * Returns the bar width.
  74:      * 
  75:      * @return The bar width.
  76:      */
  77:     public double getBarWidth() {
  78:         return this.barWidth;
  79:     }
  80:     
  81:     /**
  82:      * Sets the bar width.  The renderer calculates this value and stores it 
  83:      * here - it is not intended that users can manually set the bar width.
  84:      * 
  85:      * @param width  the width.
  86:      */
  87:     public void setBarWidth(double width) {
  88:         this.barWidth = width;
  89:     }
  90:     
  91:     /**
  92:      * Returns the series running total.
  93:      * 
  94:      * @return The running total.
  95:      */
  96:     public double getSeriesRunningTotal() {
  97:         return this.seriesRunningTotal;    
  98:     }
  99:     
 100:     /**
 101:      * Sets the series running total (this method is intended for the use of 
 102:      * the renderer only).
 103:      * 
 104:      * @param total  the new total.
 105:      */
 106:     void setSeriesRunningTotal(double total) {
 107:         this.seriesRunningTotal = total;
 108:     }
 109:     
 110: }