01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package com.sun.rave.designtime.ext;
42:
43: import com.sun.rave.designtime.DesignBean;
44: import com.sun.rave.designtime.DisplayActionSet;
45:
46: /**
47: * <P>The DesignInfoExt interface is an extension to DesignInfo to provide additional
48: * design-time functionality for a component. DesignInfoExt itself does not extends
49: * DesignInfo. So it acts as a <code>mixin</code>. </p>
50: *
51: * <p>The implementation class should also implement DesignInfo
52: * Ex. public class MyComponentDesignInfo implements DesignInfo, DesignInfoExt{
53: * </P>
54: *
55: * <p>The DsignInfoExt is meant to provide additional auxillary context actions that
56: * will be displayed in the designer as component decoration. Clicking on the decoration
57: * popups a menu that contains the actions provided via this interface
58: * </p>
59: * @author Winston Prakash
60: */
61: public interface DesignInfoExt {
62:
63: /**
64: * Returns the ActionSet to be shown in the right-click context menu of the
65: * component decoration.
66: *
67: * @param designBean The DesignBean that a user has right-clicked on the decoration
68: * @return An DisplayActionSet object representing a context menu to display to the user
69: * while clicking on the component decoration
70: * DisplayActionSet.smallIcon (or largeIcon) - displays as the decoration
71: * DisplayActionSet.displayActions - Used to create the popup menu
72: * DisplayActionSet.description - Provides tooltip when user places the mouse over the decoration
73: */
74: public DisplayActionSet getContextItemsExt(DesignBean designBean);
75: }
|