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.ui.support.viewfactorysupport.ICompartment;
045:
046: /**
047: * This is a marker interface that specifies an application designer compartment.
048: *
049: * @author Trey Spiva
050: */
051: public interface IADCompartment extends ICompartment {
052: public final static int LEFT = 1;
053: public final static int CENTER = 2;
054: public final static int RIGHT = 4;
055:
056: public final static int TOP = 8;
057: public final static int BOTTOM = 16;
058:
059: public final static int SINGLELINE = 32;
060: public final static int END_ELLIPSIS = 64;
061:
062: /**
063: * Sets the horizontal alignment property of the compartment. Valid
064: * values are:
065: * <ul>
066: * <li>IADEditableCompartment.LEFT</li>
067: * <li>IADEditableCompartment.CENTER</li>
068: * <li>IADEditableCompartment.RIGHT</li>
069: * </ul>
070: * @param alignment The horizonal alignment.
071: */
072: public void setHorizontalAlignment(int alignment);
073:
074: /**
075: * Retrieves the horizontal alignment property of the compartment. Valid
076: * values are:
077: * <ul>
078: * <li>IADEditableCompartment.LEFT</li>
079: * <li>IADEditableCompartment.CENTER</li>
080: * <li>IADEditableCompartment.RIGHT</li>
081: * </ul>
082: * @return The horizonal alignment.
083: */
084: public int getHorizontalAlignment();
085:
086: /**
087: * Sets the vertical alignment property of the compartment. Valid
088: * values are:
089: * <ul>
090: * <li>IADEditableCompartment.TOP</li>
091: * <li>IADEditableCompartment.CENTER</li>
092: * <li>IADEditableCompartment.BOTTOM</li>
093: * </ul>
094: * @param alignment The vertical alignment.
095: */
096: public void setVerticalAlignment(int alignment);
097:
098: /**
099: * Retrieves the vertical alignment property of the compartment. Valid
100: * values are:
101: * <ul>
102: * <li>IADEditableCompartment.TOP</li>
103: * <li>IADEditableCompartment.CENTER</li>
104: * <li>IADEditableCompartment.BOTTOM</li>
105: * </ul>
106: * @return The vertical alignment.
107: */
108: public int getVerticalAlignment();
109: }
|