KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > api > cookies > ScenarioCookie


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.xml.api.cookies;
21
22 import javax.swing.DefaultComboBoxModel JavaDoc;
23 import org.openide.filesystems.FileObject;
24 import org.openide.nodes.Node;
25
26 /**
27  * A cookie for objects which want to support scenarios
28  *
29  * @author asgeir@dimonsoftware.com
30  * @deprecated Experimantal SPI
31  */
32 public interface ScenarioCookie extends Node.Cookie {
33
34     /**
35      * Displays the Customize scenarios dialog
36      * @return true if the Customize dialog was pressed with the OK button,
37      * but false if it was closed with the Cancel button.
38      */
39     public boolean customizeScenarios();
40     
41     /**
42      * Returns the ComboBoxModel that represents the a list of scenarios.
43      * The active scenario is the selected item in that ComboBoxModel
44      * @return The ComboBoxModel that represents the a list of scenarios.
45      * The active scenario is the selected item in that ComboBoxModel.
46      */
47     public DefaultComboBoxModel JavaDoc getModel();
48     
49     /**
50      * Executes an object using the active scenario.
51      * If no scenario is active, the Customize scenarios dialog is displayed
52      * before execution.
53      */
54     public void executeActiveScenario();
55 }
56
Popular Tags