001 /* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2008, 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 * CategoryItemRendererState.java
029 * ------------------------------
030 * (C) Copyright 2003-2008, by Object Refinery Limited.
031 *
032 * Original Author: David Gilbert (for Object Refinery Limited);
033 * Contributor(s): -;
034 *
035 * Changes (since 20-Oct-2003):
036 * ----------------------------
037 * 20-Oct-2003 : Added series running total (DG);
038 * ------------- JFREECHART 1.0.x ---------------------------------------------
039 * 01-Dec-2006 : Updated API docs (DG);
040 * 26-Jun-2008 : Added CrosshairState (DG);
041 *
042 */
043
044 package org.jfree.chart.renderer.category;
045
046 import org.jfree.chart.plot.CategoryCrosshairState;
047 import org.jfree.chart.plot.PlotRenderingInfo;
048 import org.jfree.chart.renderer.RendererState;
049
050 /**
051 * An object that retains temporary state information for a
052 * {@link CategoryItemRenderer}.
053 */
054 public class CategoryItemRendererState extends RendererState {
055
056 /** The bar width. */
057 private double barWidth;
058
059 /** The series running total. */
060 private double seriesRunningTotal;
061
062 /**
063 * State information for crosshairs in the plot (this is updated by the
064 * renderer, but may be passed to several renderers in one chart).
065 *
066 * @since 1.0.11
067 */
068 private CategoryCrosshairState crosshairState;
069
070 /**
071 * Creates a new object for recording temporary state information for a
072 * renderer.
073 *
074 * @param info the plot rendering info (<code>null</code> permitted).
075 */
076 public CategoryItemRendererState(PlotRenderingInfo info) {
077 super(info);
078 this.barWidth = 0.0;
079 this.seriesRunningTotal = 0.0;
080 }
081
082 /**
083 * Returns the bar width.
084 *
085 * @return The bar width.
086 *
087 * @see #setBarWidth(double)
088 */
089 public double getBarWidth() {
090 return this.barWidth;
091 }
092
093 /**
094 * Sets the bar width. The renderer calculates this value and stores it
095 * here - it is not intended that users can manually set the bar width.
096 *
097 * @param width the width.
098 *
099 * @see #getBarWidth()
100 */
101 public void setBarWidth(double width) {
102 this.barWidth = width;
103 }
104
105 /**
106 * Returns the series running total.
107 *
108 * @return The running total.
109 *
110 * @see #setSeriesRunningTotal(double)
111 */
112 public double getSeriesRunningTotal() {
113 return this.seriesRunningTotal;
114 }
115
116 /**
117 * Sets the series running total (this method is intended for the use of
118 * the renderer only).
119 *
120 * @param total the new total.
121 *
122 * @see #getSeriesRunningTotal()
123 */
124 void setSeriesRunningTotal(double total) {
125 this.seriesRunningTotal = total;
126 }
127
128 /**
129 * Returns the crosshair state, if any.
130 *
131 * @return The crosshair state (possibly <code>null</code>).
132 *
133 * @since 1.0.11
134 *
135 * @see #setCrosshairState(CategoryCrosshairState)
136 */
137 public CategoryCrosshairState getCrosshairState() {
138 return this.crosshairState;
139 }
140
141 /**
142 * Sets the crosshair state.
143 *
144 * @param state the new state (<code>null</code> permitted).
145 *
146 * @since 1.0.11
147 *
148 * @see #getCrosshairState()
149 */
150 public void setCrosshairState(CategoryCrosshairState state) {
151 this.crosshairState = state;
152 }
153
154 }