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: * CompositeTitle.java 29: * ------------------- 30: * (C) Copyright 2005, 2007, by David Gilbert and Contributors. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 19-Nov-2004 : Version 1 (DG); 38: * 11-Jan-2005 : Removed deprecated code in preparation for 1.0.0 release (DG); 39: * 04-Feb-2005 : Implemented MAXIMUM_WIDTH in calculateSize (DG); 40: * 20-Apr-2005 : Added new draw() method (DG); 41: * 03-May-2005 : Implemented equals() method (DG); 42: * 43: */ 44: 45: package org.jfree.chart.title; 46: 47: import java.awt.Graphics2D; 48: import java.awt.geom.Rectangle2D; 49: import java.io.Serializable; 50: 51: import org.jfree.chart.block.BlockContainer; 52: import org.jfree.chart.block.BorderArrangement; 53: import org.jfree.chart.block.RectangleConstraint; 54: import org.jfree.ui.Size2D; 55: 56: /** 57: * A title that contains multiple titles within a {@link BlockContainer}. 58: */ 59: public class CompositeTitle extends Title implements Cloneable, Serializable { 60: 61: /** For serialization. */ 62: private static final long serialVersionUID = -6770854036232562290L; 63: 64: /** A container for the individual titles. */ 65: private BlockContainer container; 66: 67: /** 68: * Creates a new composite title with a default border arrangement. 69: */ 70: public CompositeTitle() { 71: this(new BlockContainer(new BorderArrangement())); 72: } 73: 74: /** 75: * Creates a new title using the specified container. 76: * 77: * @param container the container (<code>null</code> not permitted). 78: */ 79: public CompositeTitle(BlockContainer container) { 80: if (container == null) { 81: throw new IllegalArgumentException("Null 'container' argument."); 82: } 83: this.container = container; 84: } 85: 86: /** 87: * Returns the container holding the titles. 88: * 89: * @return The title container (never <code>null</code>). 90: */ 91: public BlockContainer getContainer() { 92: return this.container; 93: } 94: 95: /** 96: * Sets the title container. 97: * 98: * @param container the container (<code>null</code> not permitted). 99: */ 100: public void setTitleContainer(BlockContainer container) { 101: if (container == null) { 102: throw new IllegalArgumentException("Null 'container' argument."); 103: } 104: this.container = container; 105: } 106: 107: /** 108: * Arranges the contents of the block, within the given constraints, and 109: * returns the block size. 110: * 111: * @param g2 the graphics device. 112: * @param constraint the constraint (<code>null</code> not permitted). 113: * 114: * @return The block size (in Java2D units, never <code>null</code>). 115: */ 116: public Size2D arrange(Graphics2D g2, RectangleConstraint constraint) { 117: RectangleConstraint contentConstraint = toContentConstraint(constraint); 118: Size2D contentSize = this.container.arrange(g2, contentConstraint); 119: return new Size2D(calculateTotalWidth(contentSize.getWidth()), 120: calculateTotalHeight(contentSize.getHeight())); 121: } 122: 123: /** 124: * Draws the title on a Java 2D graphics device (such as the screen or a 125: * printer). 126: * 127: * @param g2 the graphics device. 128: * @param area the area allocated for the title. 129: */ 130: public void draw(Graphics2D g2, Rectangle2D area) { 131: area = trimMargin(area); 132: drawBorder(g2, area); 133: area = trimBorder(area); 134: area = trimPadding(area); 135: this.container.draw(g2, area); 136: } 137: 138: /** 139: * Draws the block within the specified area. 140: * 141: * @param g2 the graphics device. 142: * @param area the area. 143: * @param params ignored (<code>null</code> permitted). 144: * 145: * @return Always <code>null</code>. 146: */ 147: public Object draw(Graphics2D g2, Rectangle2D area, Object params) { 148: draw(g2, area); 149: return null; 150: } 151: 152: /** 153: * Tests this title for equality with an arbitrary object. 154: * 155: * @param obj the object (<code>null</code> permitted). 156: * 157: * @return A boolean. 158: */ 159: public boolean equals(Object obj) { 160: if (obj == this) { 161: return true; 162: } 163: if (!(obj instanceof CompositeTitle)) { 164: return false; 165: } 166: if (!super.equals(obj)) { 167: return false; 168: } 169: CompositeTitle that = (CompositeTitle) obj; 170: if (!this.container.equals(that.container)) { 171: return false; 172: } 173: return true; 174: } 175: 176: }