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:
42: package com.sun.rave.designtime;
43:
44: import java.awt.Image;
45:
46: /**
47: * <P>The DisplayItem interface describes the basic information needed to display an action in a
48: * menu or a button. Several interfaces in Creator Design-Time API extend this one to provide a
49: * basic name, description, icon, etc.</P>
50: *
51: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
52: * the component (bean) author. There are several Basic* classes that implement this interface
53: * for you.</P>
54: *
55: * @author Joe Nuxoll
56: * @version 1.0
57: */
58: public interface DisplayItem {
59:
60: /**
61: * Returns a display name for this item. This will be used to show in a menu or as a button
62: * label, depending on the subinterface.
63: *
64: * @return A String representing the display name for this item.
65: */
66: public String getDisplayName();
67:
68: /**
69: * Returns a description for this item. This will be used as a tooltip in a menu or on a
70: * button, depending on the subinterface.
71: *
72: * @return A String representing the description for this item.
73: */
74: public String getDescription();
75:
76: /**
77: * Returns a large image icon for this item. Generally "large" means 32x32 pixels.
78: *
79: * @return An Image representing the large icon for this item.
80: */
81: public Image getLargeIcon();
82:
83: /**
84: * Returns a small image icon for this item. Generally "small" means 16x16 pixels.
85: *
86: * @return An Image representing the large icon for this item.
87: */
88: public Image getSmallIcon();
89:
90: /**
91: * Returns the help key for this item. This is usually a key used to look up a help context
92: * item in an online help facility.
93: *
94: * @return A String representing the help key for this item.
95: */
96: public String getHelpKey();
97: }
|