01: /*
02: * Copyright 1996-2001 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 an interface for classes that know how to layout Containers
29: * based on a layout constraints object.
30: *
31: * This interface extends the LayoutManager interface to deal with layouts
32: * explicitly in terms of constraint objects that specify how and where
33: * components should be added to the layout.
34: * <p>
35: * This minimal extension to LayoutManager is intended for tool
36: * providers who wish to the creation of constraint-based layouts.
37: * It does not yet provide full, general support for custom
38: * constraint-based layout managers.
39: *
40: * @see LayoutManager
41: * @see Container
42: *
43: * @version 1.21, 05/05/07
44: * @author Jonni Kanerva
45: */
46: public interface LayoutManager2 extends LayoutManager {
47:
48: /**
49: * Adds the specified component to the layout, using the specified
50: * constraint object.
51: * @param comp the component to be added
52: * @param constraints where/how the component is added to the layout.
53: */
54: void addLayoutComponent(Component comp, Object constraints);
55:
56: /**
57: * Calculates the maximum size dimensions for the specified container,
58: * given the components it contains.
59: * @see java.awt.Component#getMaximumSize
60: * @see LayoutManager
61: */
62: public Dimension maximumLayoutSize(Container target);
63:
64: /**
65: * Returns the alignment along the x axis. This specifies how
66: * the component would like to be aligned relative to other
67: * components. The value should be a number between 0 and 1
68: * where 0 represents alignment along the origin, 1 is aligned
69: * the furthest away from the origin, 0.5 is centered, etc.
70: */
71: public float getLayoutAlignmentX(Container target);
72:
73: /**
74: * Returns the alignment along the y axis. This specifies how
75: * the component would like to be aligned relative to other
76: * components. The value should be a number between 0 and 1
77: * where 0 represents alignment along the origin, 1 is aligned
78: * the furthest away from the origin, 0.5 is centered, etc.
79: */
80: public float getLayoutAlignmentY(Container target);
81:
82: /**
83: * Invalidates the layout, indicating that if the layout manager
84: * has cached information it should be discarded.
85: */
86: public void invalidateLayout(Container target);
87:
88: }
|