Arrangement


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