nextapp.echo.app.LayoutData Maven / Gradle / Ivy
/*
* This file is part of the Echo Web Application Framework (hereinafter "Echo").
* Copyright (C) 2002-2009 NextApp, Inc.
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*/
package nextapp.echo.app;
import java.io.Serializable;
/**
* Describes the interface between a child Component and its
* parent Component. A LayoutData object may
* contain layout, position, color, or other data to describe how a given
* Component should be rendered within its parent.
* LayoutData objects are used as values of the
* layoutData property defined in the Component
* class.
*
* LayoutData is a marker interface which is implemented by all
* objects providing such layout information. A component which needs to present
* layout information to its parent should use the specific derivative of
* LayoutData applicable to its parent component, e.g., a child
* of a Grid might use the GridLayoutData
* implementation. The specific LayoutData implementations
* available for use with a given parent component will be described in the
* parent component's documentation.
*
* WARNING: Setting an incompatible LayoutData
* property on a Component may result in a render-time exception
* being thrown. Take care to check the requirements specified by the
* documentation of a container Component before setting a
* LayoutData on a child of that container.
*/
public interface LayoutData
extends Serializable { }