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: * Arrangement.java 29: * ---------------- 30: * (C) Copyright 2004-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes: 36: * -------- 37: * 22-Oct-2004 : Version 1 (DG); 38: * 11-Feb-2005 : Modified arrange() method to return Size2D (DG); 39: * 22-Apr-2005 : Reordered arguments in arrange() method (DG); 40: * 41: */ 42: 43: package org.jfree.chart.block; 44: 45: import java.awt.Graphics2D; 46: 47: import org.jfree.ui.Size2D; 48: 49: /** 50: * An object that is responsible for arranging a collection of {@link Block}s 51: * within a {@link BlockContainer}. 52: */ 53: public interface Arrangement { 54: 55: /** 56: * Adds a block and a key which can be used to determine the position of 57: * the block in the arrangement. This method is called by the container 58: * (you don't need to call this method directly) and gives the arrangement 59: * an opportunity to record the details if they are required. 60: * 61: * @param block the block. 62: * @param key the key (<code>null</code> permitted). 63: */ 64: public void add(Block block, Object key); 65: 66: /** 67: * Arranges the blocks within the specified container, subject to the given 68: * constraint. 69: * 70: * @param container the container. 71: * @param g2 the graphics device. 72: * @param constraint the constraint. 73: * 74: * @return The container size after the arrangement. 75: */ 76: public Size2D arrange(BlockContainer container, 77: Graphics2D g2, 78: RectangleConstraint constraint); 79: 80: /** 81: * Clears any cached layout information retained by the arrangement. 82: */ 83: public void clear(); 84: 85: }