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.compartments;
043:
044: import org.netbeans.modules.uml.core.metamodel.core.foundation.IElement;
045:
046: public interface INameListCompartment extends IADListCompartment {
047:
048: // This is the name compartment used to lookup into essentialconfig.etc
049: public void setNameCompartment(String sNameCompartmentName);
050:
051: // Attaches this compartment to a IElement
052: public void attach(IElement pElement);
053:
054: //Updates the properties, stereotype and package import compartments
055: public boolean updateAllOptionalCompartments(IElement pElement);
056:
057: // Returns the stereotype compartment that is a child of this list compartment.
058: public IStereotypeCompartment getStereotypeCompartment();
059:
060: // Returns the tagged values compartment that is a child of this list compartment.
061: public ITaggedValuesCompartment getTaggedValuesCompartment();
062:
063: // Returns the package import compartment that is a child of this list compartment.
064: public IPackageImportCompartment getPackageImportCompartment();
065:
066: // Returns the name compartment that is a child of this list compartment.
067: public IADNameCompartment getNameCompartment();
068:
069: // TRUE to enable the template parameters compartment in this name list
070: public boolean getTemplateParameterCompartmentEnabled();
071:
072: // TRUE to enable the template parameters compartment in this name list
073: public void setTemplateParameterCompartmentEnabled(boolean pEnabled);
074:
075: // TRUE to enable the package import compartment in this name list. Default is true
076: public boolean getPackageImportCompartmentEnabled();
077:
078: // TRUE to enable the package import compartment in this name list. Default is true
079: public void setPackageImportCompartmentEnabled(boolean bEnabled);
080:
081: // TRUE to resize this node when the associated model element might change.
082: public boolean getResizeToFitCompartments();
083:
084: // TRUE to resize this node when the associated model element might change.
085: public void setResizeToFitCompartments(boolean bResizeToFit);
086:
087: // This adds a static text compartment to the top of the name list
088: public void addStaticText(String sStaticText);
089:
090: //The template compartment overlaps the compartment below and sticks out to the right.
091: // HRESULT GetTemplateParameterRect( [in]IDrawInfo* pInfo,
092: // [out]IETRect* *pNonTemplateRect,
093: // [out]IETRect* *pTemplateRect,
094: // [out]long* pXOverlap,
095: // [out]long* pYOverlap);
096:
097: // Overrides the default resource ID for an optional compartment. Allows drawengines to control optional compartment drawing behavior.
098: // HRESULT SetChildDefaultResourceID( [in] OptionalCompartment nCompartmentKind, [in] ResourceIDKind nKind, [in] BSTR sName );
099:
100: // Returns the default resource ID for an optional compartment.
101: // HRESULT GetChildDefaultResourceID( [in] OptionalCompartment nCompartmentKind, [in] ResourceIDKind nKind, [out] BSTR* sName );
102:
103: // // Returns the subcompartments that are standard with this type of list compartment
104: // HRESULT BreakAppartListCompartment([out] IADStaticTextCompartment** pStaticTextCompartment,
105: // [out] IStereotypeCompartment** pStereotypeCompartment,
106: // [out] ITaggedValuesCompartment** pTaggedValuesCompartment,
107: // [out] IPackageImportCompartment** pPackageImportCompartment,
108: // [out] IADNameCompartment** pNameCompartment);
109:
110: }
|