01: /*
02: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
03: * Copyright (C) 2002-2005 NextApp, Inc.
04: *
05: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
06: *
07: * The contents of this file are subject to the Mozilla Public License Version
08: * 1.1 (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: * http://www.mozilla.org/MPL/
11: *
12: * Software distributed under the License is distributed on an "AS IS" basis,
13: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14: * for the specific language governing rights and limitations under the
15: * License.
16: *
17: * Alternatively, the contents of this file may be used under the terms of
18: * either the GNU General Public License Version 2 or later (the "GPL"), or
19: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20: * in which case the provisions of the GPL or the LGPL are applicable instead
21: * of those above. If you wish to allow use of your version of this file only
22: * under the terms of either the GPL or the LGPL, and not to allow others to
23: * use your version of this file under the terms of the MPL, indicate your
24: * decision by deleting the provisions above and replace them with the notice
25: * and other provisions required by the GPL or the LGPL. If you do not delete
26: * the provisions above, a recipient may use your version of this file under
27: * the terms of any one of the MPL, the GPL or the LGPL.
28: */
29:
30: package nextapp.echo2.app;
31:
32: import java.io.Serializable;
33:
34: /**
35: * Describes the interface between a child <code>Component</code> and its
36: * parent <code>Component</code>. A <code>LayoutData</code> object may
37: * contain layout, position, color, or other data to describe how a given
38: * <code>Component</code> should be rendered within its parent.
39: * <code>LayoutData</code> objects are used as values of the
40: * <code>layoutData</code> property defined in the <code>Component</code>
41: * class.
42: * <p>
43: * <code>LayoutData</code> is a marker interface which is implemented by all
44: * objects providing such layout information. A component which needs to present
45: * layout information to its parent should use the specific derivative of
46: * <code>LayoutData</code> applicable to its parent component, e.g., a child
47: * of a <code>Grid</code> might use the <code>GridLayoutData</code>
48: * implementation. The specific <code>LayoutData</code> implementations
49: * available for use with a given parent component will be described in the
50: * parent component's documentation.
51: * <p>
52: * <strong>WARNING: </strong> Setting an incompatible <code>LayoutData</code>
53: * property on a <code>Component</code> may result in a render-time exception
54: * being thrown. Take care to check the requirements specified by the
55: * documentation of a container <code>Component</code> before setting a
56: * <code>LayoutData</code> on a child of that container.
57: */
58: public interface LayoutData extends Serializable {
59: }
|