001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.ui.products.ad.ADDrawEngines;
043:
044: import org.netbeans.modules.uml.core.metamodel.core.foundation.IElement;
045: import org.netbeans.modules.uml.core.metamodel.core.foundation.IPresentationElement;
046: import org.netbeans.modules.uml.core.support.umlutils.ETList;
047: import org.netbeans.modules.uml.ui.support.applicationmanager.INodePresentation;
048:
049: /**
050: * @author sumitabhk
051: *
052: */
053: public interface IADContainerDrawEngine extends IADNodeDrawEngine {
054: // Returns true when there are contained presentation elements
055: public boolean hasContained();
056:
057: // Retrieve the presentation elements contained within this container node
058: public ETList<IPresentationElement> getContained();
059:
060: /**
061: * Retrieve the presentation elements contained within this container.
062: *
063: * @param bNeedOnlyOne
064: * @param deep to recursively search for contained presentation elements.
065: * If a container contains a container the sub containers
066: * children should be returned if deep is true.
067: * @param verify test if the list of children should be verified before
068: * being returned.
069: * @return The list of children.
070: */
071: public ETList<IPresentationElement> getContained(
072: boolean bNeedOnlyOne, boolean deep, boolean verify);
073:
074: // Populates this container with what it's contents should be
075: public boolean populate();
076:
077: // Tells the container that it should start containing the argument presentation element
078: public void beginContainment(INodePresentation pPreviousContainer,
079: IPresentationElement pPresentationElement);
080:
081: // Tells the container that it should start containing the argument presentation elements
082: public void beginContainment(INodePresentation pPreviousContainer,
083: ETList<IPresentationElement> pPresentationElements);
084:
085: // Tells the container that it should stop containing the argument presentation element
086: public void endContainment(
087: ETList<IPresentationElement> pPresentationElements);
088:
089: // Sets the type of container this guy is. The long is an OR value of the ContainmentType
090: public void setContainmentType(int nContainmentType);
091:
092: // The type of container this guy is
093: public int getContainmentType();
094:
095: // Allows you to turn on and off the containment mechanism of this node
096: public void setIsGraphicalContainer(boolean bIsGraphicalContainer);
097:
098: // Allows you to turn on and off the containment mechanism of this node
099: public boolean getIsGraphicalContainer();
100:
101: // Retrieves the model element from the compartment containing the presentation element
102: public IElement getContainingModelElement(
103: IPresentationElement pPresentationElement);
104:
105: public ETList<IPresentationElement> getDeepContained();
106:
107: }
|