/*
 * Copyright (c) 1995, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package java.awt;

Defines the interface for classes that know how to lay out Containers.

Swing's painting architecture assumes the children of a JComponent do not overlap. If a JComponent's LayoutManager allows children to overlap, the JComponent must override isOptimizedDrawingEnabled to return false.

Author: Sami Shaio, Arthur van Hoff
See Also:
/** * Defines the interface for classes that know how to lay out * {@code Container}s. * <p> * Swing's painting architecture assumes the children of a * {@code JComponent} do not overlap. If a * {@code JComponent}'s {@code LayoutManager} allows * children to overlap, the {@code JComponent} must override * {@code isOptimizedDrawingEnabled} to return false. * * @see Container * @see javax.swing.JComponent#isOptimizedDrawingEnabled * * @author Sami Shaio * @author Arthur van Hoff */
public interface LayoutManager {
If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.
Params:
  • name – the string to be associated with the component
  • comp – the component to be added
/** * If the layout manager uses a per-component string, * adds the component {@code comp} to the layout, * associating it * with the string specified by {@code name}. * * @param name the string to be associated with the component * @param comp the component to be added */
void addLayoutComponent(String name, Component comp);
Removes the specified component from the layout.
Params:
  • comp – the component to be removed
/** * Removes the specified component from the layout. * @param comp the component to be removed */
void removeLayoutComponent(Component comp);
Calculates the preferred size dimensions for the specified container, given the components it contains.
Params:
  • parent – the container to be laid out
See Also:
Returns:the preferred dimension for the container
/** * Calculates the preferred size dimensions for the specified * container, given the components it contains. * * @param parent the container to be laid out * @return the preferred dimension for the container * * @see #minimumLayoutSize */
Dimension preferredLayoutSize(Container parent);
Calculates the minimum size dimensions for the specified container, given the components it contains.
Params:
  • parent – the component to be laid out
See Also:
Returns:the minimum dimension for the container
/** * Calculates the minimum size dimensions for the specified * container, given the components it contains. * * @param parent the component to be laid out * @return the minimum dimension for the container * * @see #preferredLayoutSize */
Dimension minimumLayoutSize(Container parent);
Lays out the specified container.
Params:
  • parent – the container to be laid out
/** * Lays out the specified container. * @param parent the container to be laid out */
void layoutContainer(Container parent); }