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.metamodel.core.foundation.IPresentationElement;
045: import org.netbeans.modules.uml.core.support.umlutils.ETList;
046:
047: import java.awt.Point;
048:
049: public interface IProductContextMenu {
050: /**
051: * Should the context menu be canceled?
052: */
053: public boolean getCancel();
054:
055: /**
056: * Should the context menu be canceled?
057: */
058: public void setCancel(boolean value);
059:
060: /**
061: * The position of the mouse when this menu was created.
062: */
063: public Point getLogicalMousePosition();
064:
065: /**
066: * The position of the mouse when this menu was created.
067: */
068: public long setLogicalMousePosition(int lLogicalX, int lLogicalY);
069:
070: /**
071: * The Node, Edge or Label that was right clicked on
072: */
073: public Object getItemClickedOn();
074:
075: /**
076: * The Node, Edge or Label that was right clicked on
077: */
078: public void setItemClickedOn(Object value);
079:
080: /**
081: * The Node, Edge or Label that was right clicked on, returned as a presentation element.
082: */
083: public IPresentationElement getPresentationElementClickedOn();
084:
085: /**
086: * The title of the context menu
087: */
088: public String getMenuTitle();
089:
090: /**
091: * The title of the context menu
092: */
093: public void setMenuTitle(String value);
094:
095: /**
096: * The menu items making up the context menu
097: */
098: public ETList<IProductContextMenuItem> getSubMenus();
099:
100: /**
101: * The menu items making up the context menu
102: */
103: public void setSubMenus(ETList<IProductContextMenuItem> value);
104:
105: /**
106: * The parent control that kicked off this event
107: */
108: public Object getParentControl();
109:
110: /**
111: * The parent control that kicked off this event
112: */
113: public void setParentControl(Object value);
114:
115: /**
116: * The display has been handled by an event listener
117: */
118: public boolean getDisplayHandled();
119:
120: /**
121: * The display has been handled by an event listener
122: */
123: public void setDisplayHandled(boolean value);
124:
125: /**
126: * The object that should sort the context menu
127: */
128: public IProductContextMenuSorter getSorter();
129:
130: /**
131: * The object that should sort the context menu
132: */
133: public void setSorter(IProductContextMenuSorter value);
134:
135: /**
136: * Sort the context menu
137: */
138: public long sort();
139:
140: /**
141: * The closed list that will be notified when the context menu goes away
142: */
143: public IProductContextMenuClosedList getClosedList();
144:
145: /**
146: * The closed list that will be notified when the context menu goes away
147: */
148: public void setClosedList(IProductContextMenuClosedList value);
149:
150: /**
151: * Adds a closed list item to the list.
152: */
153: public long addToClosedList(IProductContextMenuClosed newVal);
154:
155: /**
156: * Searches through the menus and submenus to find the first menuitem with thisID
157: */
158: public IProductContextMenuItem getMenuItemByID(int nMenuID);
159:
160: /**
161: * Searches through the menus and submenus to find the first menuitem with buttonSource
162: */
163: public IProductContextMenuItem getMenuItemByButtonSource(
164: String sButtonSource);
165:
166: /**
167: * Searches through the menus and submenus to find the first menuitem with name
168: */
169: public IProductContextMenuItem getMenuItemByName(String sName);
170:
171: /**
172: * Searches through the menus and submenus to remove the first menuitem with buttonSource
173: */
174: public boolean removeMenuItemByButtonSource(String sButtonSource);
175:
176: }
|