| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LayoutedContainer |
|
| 1.0;1 |
| 1 | /* $Id: LayoutedContainer.java 17858 2010-01-12 19:59:48Z linus $ | |
| 2 | ***************************************************************************** | |
| 3 | * Copyright (c) 2009 Contributors - see below | |
| 4 | * All rights reserved. This program and the accompanying materials | |
| 5 | * are made available under the terms of the Eclipse Public License v1.0 | |
| 6 | * which accompanies this distribution, and is available at | |
| 7 | * http://www.eclipse.org/legal/epl-v10.html | |
| 8 | * | |
| 9 | * Contributors: | |
| 10 | * mvw | |
| 11 | ***************************************************************************** | |
| 12 | * | |
| 13 | * Some portions of this file was previously release using the BSD License: | |
| 14 | */ | |
| 15 | ||
| 16 | // Copyright (c) 1996-2006 The Regents of the University of California. All | |
| 17 | // Rights Reserved. Permission to use, copy, modify, and distribute this | |
| 18 | // software and its documentation without fee, and without a written | |
| 19 | // agreement is hereby granted, provided that the above copyright notice | |
| 20 | // and this paragraph appear in all copies. This software program and | |
| 21 | // documentation are copyrighted by The Regents of the University of | |
| 22 | // California. The software program and documentation are supplied "AS | |
| 23 | // IS", without any accompanying services from The Regents. The Regents | |
| 24 | // does not warrant that the operation of the program will be | |
| 25 | // uninterrupted or error-free. The end-user understands that the program | |
| 26 | // was developed for research purposes and is advised not to rely | |
| 27 | // exclusively on the program for any reason. IN NO EVENT SHALL THE | |
| 28 | // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, | |
| 29 | // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, | |
| 30 | // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF | |
| 31 | // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF | |
| 32 | // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY | |
| 33 | // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
| 34 | // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE | |
| 35 | // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF | |
| 36 | // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, | |
| 37 | // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | |
| 38 | ||
| 39 | package org.argouml.uml.diagram.layout; | |
| 40 | ||
| 41 | import java.awt.*; | |
| 42 | ||
| 43 | ||
| 44 | /** | |
| 45 | * This interface is for container in a layouted diagram. They are | |
| 46 | * intended to hold other object like nodes or even other containers. | |
| 47 | * An example are nested packages in classdiagrams. | |
| 48 | */ | |
| 49 | public interface LayoutedContainer { | |
| 50 | ||
| 51 | /** | |
| 52 | * Add an object to this container. | |
| 53 | * | |
| 54 | * @param obj represents the object to add to this container. | |
| 55 | */ | |
| 56 | void add(LayoutedObject obj); | |
| 57 | ||
| 58 | /** | |
| 59 | * Remove an object from this container. | |
| 60 | * | |
| 61 | * @param obj represents the object to be removed. | |
| 62 | */ | |
| 63 | void remove(LayoutedObject obj); | |
| 64 | ||
| 65 | /** | |
| 66 | * Operation getContent returns all the objects from | |
| 67 | * this container. | |
| 68 | * | |
| 69 | * @return All the objects from this container. | |
| 70 | */ | |
| 71 | LayoutedObject [] getContent(); | |
| 72 | ||
| 73 | /** | |
| 74 | * Resize this container, so it fits the layouted objects within itself. | |
| 75 | * | |
| 76 | * @param newSize represents The new size of this container. | |
| 77 | */ | |
| 78 | void resize(Dimension newSize); | |
| 79 | } |