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.support.contextmenusupport;
043:
044: import org.netbeans.modules.uml.core.support.umlutils.ETList;
045:
046: public interface IProductContextMenuItem {
047: /**
048: * Is this item sensitive?
049: */
050: public boolean getSensitive();
051:
052: /**
053: * Is this item sensitive?
054: */
055: public void setSensitive(boolean value);
056:
057: /**
058: * Applicable when a selection event occurs. Has this items selection been handled?
059: */
060: public boolean getHandled();
061:
062: /**
063: * Applicable when a selection event occurs. Has this items selection been handled?
064: */
065: public void setHandled(boolean value);
066:
067: /**
068: * Is this item a separator in the menu?
069: */
070: public boolean getIsSeparator();
071:
072: /**
073: * Is this item a separator in the menu?
074: */
075: public void setIsSeparator(boolean value);
076:
077: /**
078: * What is the menu string?
079: */
080: public String getMenuString();
081:
082: /**
083: * What is the menu string?
084: */
085: public void setMenuString(String value);
086:
087: /**
088: * The description of what the menu does.
089: */
090: public String getDescription();
091:
092: /**
093: * The description of what the menu does.
094: */
095: public void setDescription(String value);
096:
097: /**
098: * The menu ID of this menu. By default all menu items get a unique menu ID.
099: */
100: public int getMenuID();
101:
102: /**
103: * The menu ID of this menu. By default all menu items get a unique menu ID.
104: */
105: public void setMenuID(int value);
106:
107: /**
108: * The sub menus of this item. If this item has sub menus then it becomes a popup menu.
109: */
110: public ETList<IProductContextMenuItem> getSubMenus();
111:
112: /**
113: * The sub menus of this item. If this item has sub menus then it becomes a popup menu.
114: */
115: public void setSubMenus(IProductContextMenuItem[] value);
116:
117: /**
118: * Is this item checked?
119: */
120: public boolean getChecked();
121:
122: /**
123: * Is this item checked?
124: */
125: public void setChecked(boolean value);
126:
127: /**
128: * The id that was used when an engine created this item.
129: */
130: public String getButtonSource();
131:
132: /**
133: * The id that was used when an engine created this item.
134: */
135: public void setButtonSource(String value);
136:
137: /**
138: * If the popup is actually created by a listener then this is who the listener calls if a button is selected.
139: */
140: public IProductContextMenuSelectionHandler getSelectionHandler();
141:
142: /**
143: * If the popup is actually created by a listener then this is who the listener calls if a button is selected.
144: */
145: public void setSelectionHandler(
146: IProductContextMenuSelectionHandler value);
147:
148: /**
149: * Ensure that this button is a pullright. If it has no subitems then desensitize the button.
150: */
151: public boolean getEnsurePullright();
152:
153: /**
154: * Ensure that this button is a pullright. If it has no subitems then desensitize the button.
155: */
156: public void setEnsurePullright(boolean value);
157:
158: }
|