KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > ILaunchConfigurationDialog


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.debug.ui;
12
13 import org.eclipse.jface.operation.IRunnableContext;
14
15  
16  /**
17   * A launch configuration dialog is used to edit and launch
18   * launch configurations. It contains a launch configuration
19   * tab group.
20   * <p>
21   * Clients are not intended to implement this interface.
22   * </p>
23   * @see ILaunchConfigurationTabGroup
24   * @see ILaunchConfigurationTab
25   * @since 2.0
26   */
27
28 public interface ILaunchConfigurationDialog extends IRunnableContext {
29     
30     /**
31      * Return value from <code>open()</code> method of a
32      * launch configuration dialog when a launch completed
33      * successfully with a single click (without opening a
34      * launch configuration dialog).
35      *
36      * @deprecated the launch dialog no longer supports launching without
37      * opening - this constant will never be returned by the dialog
38      */
39     public static final int LAUNCHED_BEFORE_OPENING = 2;
40             
41     /**
42      * Adjusts the enable state of this dialog's buttons
43      * to reflect the state of the active tab group.
44      * <p>
45      * This may be called by to force a button state
46      * update.
47      * </p>
48      */
49     public void updateButtons();
50     
51     /**
52      * Updates the message (or error message) shown in the message line to
53      * reflect the state of the currently active tab in this launch
54      * configuration dialog.
55      * <p>
56      * This method may be called to force a message
57      * update.
58      * </p>
59      */
60     public void updateMessage();
61     
62     /**
63      * Sets the contents of the name field to the given name.
64      *
65      * @param name new name value
66      */
67     public void setName(String JavaDoc name);
68     
69     /**
70      * Returns a unique launch configuration name, using the given name
71      * as a seed.
72      *
73      * @param name seed from which to generate a new unique name
74      */
75     public String JavaDoc generateName(String JavaDoc name);
76     
77     /**
78      * Returns the tabs currently being displayed, or
79      * <code>null</code> if none.
80      *
81      * @return currently displayed tabs, or <code>null</code>
82      */
83     public ILaunchConfigurationTab[] getTabs();
84     
85     /**
86      * Returns the currently active <code>ILaunchConfigurationTab</code>
87      * being displayed, or <code>null</code> if there is none.
88      *
89      * @return currently active <code>ILaunchConfigurationTab</code>, or <code>null</code>.
90      */
91     public ILaunchConfigurationTab getActiveTab();
92     
93     /**
94      * Returns the mode in which this dialog was opened -
95      * run or debug.
96      *
97      * @return one of <code>RUN_MODE</code> or <code>DEBUG_MODE</code> defined in <code>ILaunchManager</code>
98      * @see org.eclipse.debug.core.ILaunchManager
99      */
100     public String JavaDoc getMode();
101     
102     /**
103      * Sets the displayed tab to the given tab. Has no effect if the specified
104      * tab is not one of the tabs being displayed in the dialog currently.
105      *
106      * @param tab the tab to display/activate
107      * @since 2.1
108      */
109     public void setActiveTab(ILaunchConfigurationTab tab);
110     
111     /**
112      * Sets the displayed tab to the tab with the given index. Has no effect if
113      * the specified index is not within the limits of the tabs returned by
114      * <code>getTabs()</code>.
115      *
116      * @param index the index of the tab to display
117      * @since 2.1
118      */
119     public void setActiveTab(int index);
120         
121 }
122
Popular Tags