Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, 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: * AxisCollection.java 29: * ------------------- 30: * (C) Copyright 2003-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 03-Nov-2003 : Added standard header (DG); 38: * 39: */ 40: 41: package org.jfree.chart.axis; 42: 43: import java.util.List; 44: 45: import org.jfree.ui.RectangleEdge; 46: 47: /** 48: * A collection of axes that have been assigned to the TOP, BOTTOM, LEFT or 49: * RIGHT of a chart. This class is used internally by JFreeChart, you won't 50: * normally need to use it yourself. 51: */ 52: public class AxisCollection { 53: 54: /** The axes that need to be drawn at the top of the plot area. */ 55: private List axesAtTop; 56: 57: /** The axes that need to be drawn at the bottom of the plot area. */ 58: private List axesAtBottom; 59: 60: /** The axes that need to be drawn at the left of the plot area. */ 61: private List axesAtLeft; 62: 63: /** The axes that need to be drawn at the right of the plot area. */ 64: private List axesAtRight; 65: 66: /** 67: * Creates a new empty collection. 68: */ 69: public AxisCollection() { 70: this.axesAtTop = new java.util.ArrayList(); 71: this.axesAtBottom = new java.util.ArrayList(); 72: this.axesAtLeft = new java.util.ArrayList(); 73: this.axesAtRight = new java.util.ArrayList(); 74: } 75: 76: /** 77: * Returns a list of the axes (if any) that need to be drawn at the top of 78: * the plot area. 79: * 80: * @return A list of axes. 81: */ 82: public List getAxesAtTop() { 83: return this.axesAtTop; 84: } 85: 86: /** 87: * Returns a list of the axes (if any) that need to be drawn at the bottom 88: * of the plot area. 89: * 90: * @return A list of axes. 91: */ 92: public List getAxesAtBottom() { 93: return this.axesAtBottom; 94: } 95: 96: /** 97: * Returns a list of the axes (if any) that need to be drawn at the left 98: * of the plot area. 99: * 100: * @return A list of axes. 101: */ 102: public List getAxesAtLeft() { 103: return this.axesAtLeft; 104: } 105: 106: /** 107: * Returns a list of the axes (if any) that need to be drawn at the right 108: * of the plot area. 109: * 110: * @return A list of axes. 111: */ 112: public List getAxesAtRight() { 113: return this.axesAtRight; 114: } 115: 116: /** 117: * Adds an axis to the collection. 118: * 119: * @param axis the axis (<code>null</code> not permitted). 120: * @param edge the edge of the plot that the axis should be drawn on 121: * (<code>null</code> not permitted). 122: */ 123: public void add(Axis axis, RectangleEdge edge) { 124: if (axis == null) { 125: throw new IllegalArgumentException("Null 'axis' argument."); 126: } 127: if (edge == null) { 128: throw new IllegalArgumentException("Null 'edge' argument."); 129: } 130: if (edge == RectangleEdge.TOP) { 131: this.axesAtTop.add(axis); 132: } 133: else if (edge == RectangleEdge.BOTTOM) { 134: this.axesAtBottom.add(axis); 135: } 136: else if (edge == RectangleEdge.LEFT) { 137: this.axesAtLeft.add(axis); 138: } 139: else if (edge == RectangleEdge.RIGHT) { 140: this.axesAtRight.add(axis); 141: } 142: } 143: 144: }