Eclipse Platform
2.1

org.eclipse.debug.ui
Class DebugUITools

java.lang.Object
  |
  +--org.eclipse.debug.ui.DebugUITools

public class DebugUITools
extends Object

This class provides utilities for clients of the debug UI.

Images retrieved from this facility should not be disposed. The images will be disposed when this plugin is shutdown.

This class is not intended to be subclassed or instantiated.


Constructor Summary
DebugUITools()
           
 
Method Summary
static ILaunch buildAndLaunch(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor)
          Builds the workspace according to current preference settings, and launches the given configuration in the specified mode, returning the resulting launch object.
static IProcess getCurrentProcess()
          Returns the process associated with the current debug context.
static IAdaptable getDebugContext()
          Returns the currently selected element in the debug view of the current workbench page, or null if there is no current debug context, or if not called from the UI thread.
static ImageDescriptor getDefaultImageDescriptor(Object element)
          Returns the default image descriptor for the given element or null if none is defined.
static Image getImage(String key)
          Returns the shared image managed under the given key, or null if none.
static ImageDescriptor getImageDescriptor(String key)
          Returns the shared image descriptor managed under the given key, or null if none.
static IPreferenceStore getPreferenceStore()
          Returns the preference store for the debug UI plugin.
static void launch(ILaunchConfiguration configuration, String mode)
          Saves and builds the workspace according to current preference settings, and launches the given launch configuration in the specified mode with a progress dialog.
static IDebugModelPresentation newDebugModelPresentation()
          Returns a new debug model presentation that delegates to appropriate debug models.
static IDebugModelPresentation newDebugModelPresentation(String identifier)
          Returns a new debug model presentation for specified debug model, or null if a presentation does not exist.
static int openLaunchConfigurationDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier, IStatus status)
          Open the launch configuration dialog on the specified launch configuration.
static int openLaunchConfigurationDialog(Shell shell, IStructuredSelection selection, String mode)
          Open the launch configuration dialog with the specified initial selection.
static int openLaunchConfigurationDialogOnGroup(Shell shell, IStructuredSelection selection, String groupIdentifier)
          Open the launch configuration dialog with the specified initial selection.
static int openLaunchConfigurationDialogOnGroup(Shell shell, IStructuredSelection selection, String groupIdentifier, IStatus status)
          Open the launch configuration dialog with the specified initial selection.
static int openLaunchConfigurationPropertiesDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier)
          Open the launch configuration properties dialog on the specified launch configuration.
static boolean saveAndBuildBeforeLaunch()
          Saves all dirty editors and builds the workspace according to current preference settings, and returns whether a launch should proceed.
static boolean saveBeforeLaunch()
          Saves all dirty editors according to current preference settings, and returns whether a launch should proceed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DebugUITools

public DebugUITools()
Method Detail

getImage

public static Image getImage(String key)
Returns the shared image managed under the given key, or null if none.

Note that clients MUST NOT dispose the image returned by this method.

See IDebugUIConstants for available images.

Parameters:
key - the image key
Returns:
the image, or null if none
See Also:
IDebugUIConstants

getImageDescriptor

public static ImageDescriptor getImageDescriptor(String key)
Returns the shared image descriptor managed under the given key, or null if none.

See IDebugUIConstants for available image descriptors.

Parameters:
key - the image descriptor key
Returns:
the image descriptor, or null if none
See Also:
IDebugUIConstants

getDefaultImageDescriptor

public static ImageDescriptor getDefaultImageDescriptor(Object element)
Returns the default image descriptor for the given element or null if none is defined.

getPreferenceStore

public static IPreferenceStore getPreferenceStore()
Returns the preference store for the debug UI plugin.
Returns:
preference store

newDebugModelPresentation

public static IDebugModelPresentation newDebugModelPresentation()
Returns a new debug model presentation that delegates to appropriate debug models.

It is the client's responsibility dispose the presentation.

Returns:
a debug model presentation
Since:
2.0
See Also:
IBaseLabelProvider.dispose()

newDebugModelPresentation

public static IDebugModelPresentation newDebugModelPresentation(String identifier)
Returns a new debug model presentation for specified debug model, or null if a presentation does not exist.

It is the client's responsibility dispose the presentation.

Parameters:
identifier - debug model identifier
Returns:
a debug model presentation, or null
Since:
2.0
See Also:
IBaseLabelProvider.dispose()

getDebugContext

public static IAdaptable getDebugContext()
Returns the currently selected element in the debug view of the current workbench page, or null if there is no current debug context, or if not called from the UI thread.
Returns:
the currently selected debug context, or null
Since:
2.0

getCurrentProcess

public static IProcess getCurrentProcess()
Returns the process associated with the current debug context. If there is no debug context currently, the most recently launched process is returned. If there is no current process null is returned.
Returns:
the current process, or null
Since:
2.0

openLaunchConfigurationDialog

public static int openLaunchConfigurationDialog(Shell shell,
                                                IStructuredSelection selection,
                                                String mode)
Open the launch configuration dialog with the specified initial selection. The selection may be null, or contain any mix of ILaunchConfiguration or ILaunchConfigurationType elements.

Before opening a new dialog, this method checks if there is an existing open launch configuration dialog. If there is, this dialog is used with the specified selection. If there is no existing dialog, a new one is created.

Note that if an existing dialog is reused, the mode argument is ignored and the existing dialog keeps its original mode.

Parameters:
shell - the parent shell for the launch configuration dialog
selection - the initial selection for the dialog
mode - the mode (run or debug) in which to open the launch configuration dialog. This should be one of the constants defined in ILaunchManager.
Returns:
the return code from opening the launch configuration dialog - one of Window.OK or Window.CANCEL
Since:
2.0

openLaunchConfigurationDialogOnGroup

public static int openLaunchConfigurationDialogOnGroup(Shell shell,
                                                       IStructuredSelection selection,
                                                       String groupIdentifier)
Open the launch configuration dialog with the specified initial selection. The selection may be null, or contain any mix of ILaunchConfiguration or ILaunchConfigurationType elements.

Before opening a new dialog, this method checks if there is an existing open launch configuration dialog. If there is, this dialog is used with the specified selection. If there is no existing dialog, a new one is created.

Note that if an existing dialog is reused, the mode argument is ignored and the existing dialog keeps its original mode.

Parameters:
shell - the parent shell for the launch configuration dialog
selection - the initial selection for the dialog
groupIdentifier - the identifier of the launch group to display (corresponds to the identifier of a launch group extension)
Returns:
the return code from opening the launch configuration dialog - one of Window.OK or Window.CANCEL
Since:
2.1

openLaunchConfigurationDialogOnGroup

public static int openLaunchConfigurationDialogOnGroup(Shell shell,
                                                       IStructuredSelection selection,
                                                       String groupIdentifier,
                                                       IStatus status)
Open the launch configuration dialog with the specified initial selection. The selection may be null, or contain any mix of ILaunchConfiguration or ILaunchConfigurationType elements.

Before opening a new dialog, this method checks if there is an existing open launch configuration dialog. If there is, this dialog is used with the specified selection. If there is no existing dialog, a new one is created.

Note that if an existing dialog is reused, the mode argument is ignored and the existing dialog keeps its original mode.

If a status is specified, a status handler is consulted to handle the status. The status handler is passed the instance of the launch configuration dialog that is opened. This gives the status handler an opportunity to perform error handling/initialization as required.

Parameters:
shell - the parent shell for the launch configuration dialog
selection - the initial selection for the dialog
groupIdentifier - the identifier of the launch group to display (corresponds to the identifier of a launch group extension)
status - the status to display in the dialog, or null if none
Returns:
the return code from opening the launch configuration dialog - one of Window.OK or Window.CANCEL
Since:
2.1
See Also:
IStatusHandler

openLaunchConfigurationPropertiesDialog

public static int openLaunchConfigurationPropertiesDialog(Shell shell,
                                                          ILaunchConfiguration configuration,
                                                          String groupIdentifier)
Open the launch configuration properties dialog on the specified launch configuration.
Parameters:
shell - the parent shell for the launch configuration dialog
configuration - the configuration to display
group - identifier of the launch group the launch configuration belongs to
Returns:
the return code from opening the launch configuration dialog - one of Window.OK or Window.CANCEL
Since:
2.1

openLaunchConfigurationDialog

public static int openLaunchConfigurationDialog(Shell shell,
                                                ILaunchConfiguration configuration,
                                                String groupIdentifier,
                                                IStatus status)
Open the launch configuration dialog on the specified launch configuration. The dialog displays the tabs for a single configuration only (a tree of launch configuration is not displayed), and provides a launch (run or debug) button.

If a status is specified, a status handler is consulted to handle the status. The status handler is passed the instance of the launch configuration dialog that is opened. This gives the status handler an opportunity to perform error handling/initialization as required.

Parameters:
shell - the parent shell for the launch configuration dialog
configuration - the configuration to display
group - identifier of the launch group the launch configuration belongs to
status - the status to display, or null if none
Returns:
the return code from opening the launch configuration dialog - one of Window.OK or Window.CANCEL
Since:
2.1

saveAndBuildBeforeLaunch

public static boolean saveAndBuildBeforeLaunch()
Saves all dirty editors and builds the workspace according to current preference settings, and returns whether a launch should proceed.

The following preferences effect whether dirty editors are saved, and/or if the user is prompted to save dirty edtiors:

The following preference effects whether a build is performed before launching (if required):

Returns:
whether a launch should proceed
Since:
2.0

saveBeforeLaunch

public static boolean saveBeforeLaunch()
Saves all dirty editors according to current preference settings, and returns whether a launch should proceed.

The following preferences effect whether dirty editors are saved, and/or if the user is prompted to save dirty edtiors:

Returns:
whether a launch should proceed
Since:
2.1

launch

public static void launch(ILaunchConfiguration configuration,
                          String mode)
Saves and builds the workspace according to current preference settings, and launches the given launch configuration in the specified mode with a progress dialog. Reports any exceptions that occurr in an error dilaog.
Parameters:
configuration - the configuration to launch
mode - launch mode - run or debug
Since:
2.1

buildAndLaunch

public static ILaunch buildAndLaunch(ILaunchConfiguration configuration,
                                     String mode,
                                     IProgressMonitor monitor)
                              throws CoreException
Builds the workspace according to current preference settings, and launches the given configuration in the specified mode, returning the resulting launch object.

The following preference effects whether a build is performed before launching (if required):

Parameters:
configuration - the configuration to launch
mode - the mode to launch in
monitor - progress monitor
Returns:
the resulting launch object
Throws:
CoreException - if building or launching fails
Since:
2.1

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.