Home » openjdk-7 » java » awt » [javadoc | source]

    1   /*
    2    * Copyright (c) 1995, 2005, Oracle and/or its affiliates. All rights reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   package java.awt;
   26   
   27   /**
   28    * Defines the interface for classes that know how to lay out
   29    * <code>Container</code>s.
   30    * <p>
   31    * Swing's painting architecture assumes the children of a
   32    * <code>JComponent</code> do not overlap.  If a
   33    * <code>JComponent</code>'s <code>LayoutManager</code> allows
   34    * children to overlap, the <code>JComponent</code> must override
   35    * <code>isOptimizedDrawingEnabled</code> to return false.
   36    *
   37    * @see Container
   38    * @see javax.swing.JComponent#isOptimizedDrawingEnabled
   39    *
   40    * @author      Sami Shaio
   41    * @author      Arthur van Hoff
   42    */
   43   public interface LayoutManager {
   44       /**
   45        * If the layout manager uses a per-component string,
   46        * adds the component <code>comp</code> to the layout,
   47        * associating it
   48        * with the string specified by <code>name</code>.
   49        *
   50        * @param name the string to be associated with the component
   51        * @param comp the component to be added
   52        */
   53       void addLayoutComponent(String name, Component comp);
   54   
   55       /**
   56        * Removes the specified component from the layout.
   57        * @param comp the component to be removed
   58        */
   59       void removeLayoutComponent(Component comp);
   60   
   61       /**
   62        * Calculates the preferred size dimensions for the specified
   63        * container, given the components it contains.
   64        * @param parent the container to be laid out
   65        *
   66        * @see #minimumLayoutSize
   67        */
   68       Dimension preferredLayoutSize(Container parent);
   69   
   70       /**
   71        * Calculates the minimum size dimensions for the specified
   72        * container, given the components it contains.
   73        * @param parent the component to be laid out
   74        * @see #preferredLayoutSize
   75        */
   76       Dimension minimumLayoutSize(Container parent);
   77   
   78       /**
   79        * Lays out the specified container.
   80        * @param parent the container to be laid out
   81        */
   82       void layoutContainer(Container parent);
   83   }

Home » openjdk-7 » java » awt » [javadoc | source]