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>An extension of the DisplayAction interface that introduces a hierarchy (tree) structure.
46: * This allows a DisplayAction to become an arbitrary tree of items. If displayed in a menu,
47: * the DisplayActionSet is either a popup item (if isPopup() returns true), or it is displayed as
48: * a flat list of items between separators. If displayed as a button (in an option dialog), the
49: * DisplayActionSet defines a button with a popup menu on it. Note that the 'invoke()' method will
50: * never be called in a DisplayActionSet.</p>
51: *
52: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
53: * the component (bean) author.</P>
54: *
55: * @author Joe Nuxoll
56: * @version 1.0
57: */
58: public interface DisplayActionSet extends DisplayAction {
59:
60: /**
61: * Returns the list of contained DisplayAction objects. These will either be shown in a popup
62: * or a flat list depending on the 'isPopup' return value.
63: *
64: * @return An array of DisplayAction objects
65: */
66: public DisplayAction[] getDisplayActions();
67:
68: /**
69: * Returns <code>true</code> if this DisplayActionSet should be displayed as a pop-up, or
70: * <code>false</code> if it is should be represented as a flat container (for example, between
71: * separators in a context menu).
72: *
73: * @return <code>true</code> if this DisplayActionSet should be displayed as a pop-up, or
74: * <code>false</code> if it is should be represented as a flat container (for example,
75: * between separators in a context menu)
76: */
77: public boolean isPopup();
78: }
|