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-2006, 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.2 2006/12/01 16:30:22 mungady Exp $
  36:  *
  37:  * Changes (since 20-Oct-2003):
  38:  * ----------------------------
  39:  * 20-Oct-2003 : Added series running total (DG);
  40:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  41:  * 01-Dec-2006 : Updated API docs (DG);
  42:  *
  43:  */
  44: 
  45: package org.jfree.chart.renderer.category;
  46: 
  47: import org.jfree.chart.plot.PlotRenderingInfo;
  48: import org.jfree.chart.renderer.RendererState;
  49: 
  50: /**
  51:  * An object that retains temporary state information for a 
  52:  * {@link CategoryItemRenderer}.
  53:  */
  54: public class CategoryItemRendererState extends RendererState {
  55: 
  56:     /** The bar width. */
  57:     private double barWidth;
  58:     
  59:     /** The series running total. */
  60:     private double seriesRunningTotal;
  61:     
  62:     /**
  63:      * Creates a new object for recording temporary state information for a
  64:      * renderer.
  65:      * 
  66:      * @param info  the plot rendering info (<code>null</code> permitted).
  67:      */
  68:     public CategoryItemRendererState(PlotRenderingInfo info) {
  69:         super(info);
  70:         this.barWidth = 0.0;
  71:         this.seriesRunningTotal = 0.0;
  72:     }
  73:     
  74:     /**
  75:      * Returns the bar width.
  76:      * 
  77:      * @return The bar width.
  78:      * 
  79:      * @see #setBarWidth(double)
  80:      */
  81:     public double getBarWidth() {
  82:         return this.barWidth;
  83:     }
  84:     
  85:     /**
  86:      * Sets the bar width.  The renderer calculates this value and stores it 
  87:      * here - it is not intended that users can manually set the bar width.
  88:      * 
  89:      * @param width  the width.
  90:      * 
  91:      * @see #getBarWidth()
  92:      */
  93:     public void setBarWidth(double width) {
  94:         this.barWidth = width;
  95:     }
  96:     
  97:     /**
  98:      * Returns the series running total.
  99:      * 
 100:      * @return The running total.
 101:      * 
 102:      * @see #setSeriesRunningTotal(double)
 103:      */
 104:     public double getSeriesRunningTotal() {
 105:         return this.seriesRunningTotal;    
 106:     }
 107:     
 108:     /**
 109:      * Sets the series running total (this method is intended for the use of 
 110:      * the renderer only).
 111:      * 
 112:      * @param total  the new total.
 113:      * 
 114:      * @see #getSeriesRunningTotal()
 115:      */
 116:     void setSeriesRunningTotal(double total) {
 117:         this.seriesRunningTotal = total;
 118:     }
 119:     
 120: }