libjava/classpath/java/awt/LayoutManager.java

   1 /* LayoutManager.java -- lay out elements in a Container
   2    Copyright (C) 1999, 2002, 2005  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  * This interface is for laying out containers in a particular sequence.
  43  *
  44  * @author Aaron M. Renn (arenn@urbanophile.com)
  45  * @see Container
  46  * @since 1.0
  47  * @status updated to 1.4
  48  */
  49 public interface LayoutManager
  50 {
  51   /**
  52    * Adds the specified component to the layout group.
  53    *
  54    * @param name the name of the component to add
  55    * @param component the component to add
  56    */
  57   void addLayoutComponent(String name, Component component);
  58
  59   /**
  60    * Removes the specified component from the layout group.
  61    *
  62    * @param component the component to remove
  63    */
  64   void removeLayoutComponent(Component component);
  65
  66   /**
  67    * Calculates the preferred size for this container, taking into account
  68    * the components it contains.
  69    *
  70    * @param parent the parent container to lay out
  71    * @return the preferred dimensions of this container
  72    * @see #minimumLayoutSize(Container)
  73    */
  74   Dimension preferredLayoutSize(Container parent);
  75
  76   /**
  77    * Calculates the minimum size for this container, taking into account
  78    * the components it contains.
  79    *
  80    * @param parent the parent container to lay out
  81    * @return the minimum dimensions of this container
  82    * @see #preferredLayoutSize(Container)
  83    */
  84   Dimension minimumLayoutSize(Container parent);
  85
  86   /**
  87    * Lays out the components in the given container.
  88    *
  89    * @param parent the container to lay out
  90    */
  91   void layoutContainer(Container parent);
  92 } // interface LayoutManager