1 /* LayoutManager2.java -- enhanced layout manager 2 Copyright (C) 1999, 2002 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package java.awt; 40 41 /** 42 * Layout manager for laying out containers based on contraints. The 43 * constraints control how the layout will proceed. 44 * 45 * @author Aaron M. Renn (arenn@urbanophile.com) 46 * @see LayoutManager 47 * @see Container 48 * @since 1.0 49 * @status updated to 1.4 50 */ 51 public interface LayoutManager2 extends LayoutManager 52 { 53 /** 54 * Adds the specified component to the layout, with the specified 55 * constraints object. 56 * 57 * @param component the component to add 58 * @param constraints the constraints to satisfy 59 */ addLayoutComponent(Component component, Object constraints)60 void addLayoutComponent(Component component, Object constraints); 61 62 /** 63 * Determines the maximum size of the specified target container. 64 * 65 * @param target the container to lay out 66 * @return the maximum size of the container 67 * @see Component#getMaximumSize() 68 */ maximumLayoutSize(Container target)69 Dimension maximumLayoutSize(Container target); 70 71 /** 72 * Returns the preferred X axis alignment for the specified target 73 * container. This value will range from 0 to 1 where 0 is alignment 74 * closest to the origin, 0.5 is centered, and 1 is aligned furthest 75 * from the origin. 76 * 77 * @param target the target container 78 * @return the x-axis alignment preference 79 */ getLayoutAlignmentX(Container target)80 float getLayoutAlignmentX(Container target); 81 82 /** 83 * Returns the preferred Y axis alignment for the specified target 84 * container. This value will range from 0 to 1 where 0 is alignment 85 * closest to the origin, 0.5 is centered, and 1 is aligned furthest 86 * from the origin. 87 * 88 * @param target the target container 89 * @return the y-axis alignment preference 90 */ getLayoutAlignmentY(Container target)91 float getLayoutAlignmentY(Container target); 92 93 /** 94 * Forces the layout manager to purge any cached information about the 95 * layout of the target container. This will force it to be recalculated. 96 * 97 * @param target the target container 98 */ invalidateLayout(Container target)99 void invalidateLayout(Container target); 100 } // interface LayoutManager2 101