01: /*
02: * Copyright 1995-2005 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any 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: * @version 1.33, 05/05/07
41: * @author Sami Shaio
42: * @author Arthur van Hoff
43: */
44: public interface LayoutManager {
45: /**
46: * If the layout manager uses a per-component string,
47: * adds the component <code>comp</code> to the layout,
48: * associating it
49: * with the string specified by <code>name</code>.
50: *
51: * @param name the string to be associated with the component
52: * @param comp the component to be added
53: */
54: void addLayoutComponent(String name, Component comp);
55:
56: /**
57: * Removes the specified component from the layout.
58: * @param comp the component to be removed
59: */
60: void removeLayoutComponent(Component comp);
61:
62: /**
63: * Calculates the preferred size dimensions for the specified
64: * container, given the components it contains.
65: * @param parent the container to be laid out
66: *
67: * @see #minimumLayoutSize
68: */
69: Dimension preferredLayoutSize(Container parent);
70:
71: /**
72: * Calculates the minimum size dimensions for the specified
73: * container, given the components it contains.
74: * @param parent the component to be laid out
75: * @see #preferredLayoutSize
76: */
77: Dimension minimumLayoutSize(Container parent);
78:
79: /**
80: * Lays out the specified container.
81: * @param parent the container to be laid out
82: */
83: void layoutContainer(Container parent);
84: }
| 