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: /**
45: * <P>A DisplayAction represents a menu item or dialog button - depending on where and how it is
46: * used. It has a 'displayName' and a 'description' so that it can display localized text to the
47: * user. DisplayActions may be enabled or disabled ('enabled' property) to appear grayed-out as
48: * menu items or buttons. A DisplyAction can be 'invoked', and thus execute custom behavior when
49: * it is activated from a menu-pick or button-click.</P>
50: *
51: * <P>DisplayAction extends the DisplayItem interface, thus it includes 'displayName', 'description',
52: * 'largeIcon', and 'smallIcon' properties.</P>
53: *
54: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
55: * the component (bean) author. The BasicDisplayAction class can be used for convenience.</P>
56: *
57: * @author Joe Nuxoll
58: * @version 1.0
59: * @see com.sun.rave.designtime.impl.BasicDisplayAction
60: */
61: public interface DisplayAction extends DisplayItem {
62:
63: public static final DisplayAction[] EMPTY_ARRAY = {};
64:
65: /**
66: * Returns <B>true</B> if this DisplayAction should be displayed as enabled, or <B>false</B> if
67: * it should be disabled.
68: *
69: * @return <B>true</B> if this DisplayAction should be displayed as enabled, or <B>false</B> if
70: * it should be disabled.
71: */
72: public boolean isEnabled();
73:
74: /**
75: * This method is called when a DisplayAction is selected from a context menu or 'clicked' when
76: * it is displayed as a button.
77: *
78: * @return A standard Result object
79: */
80: public Result invoke();
81: }
|