|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.debug.ui.DebugUITools
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 void |
displaySource(ISourceLookupResult result,
IWorkbenchPage page)
Displays the given source lookup result in an editor in the given workbench page. |
static IConsole |
getConsole(IDebugElement element)
Returns the console associated with the given debug element, or null if none. |
static IConsole |
getConsole(IProcess process)
Returns the console associated with the given process, or null if none. |
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.
|
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 ILaunchGroup |
getLaunchGroup(ILaunchConfiguration configuration,
String mode)
Returns the launch group that the given launch configuration belongs to, for the specified mode, or null if none. |
static ILaunchGroup[] |
getLaunchGroups()
Returns all registered launch group extensions. |
static String |
getLaunchPerspective(ILaunchConfigurationType type,
String mode)
Returns the perspective to switch to when a configuration of the given type is launched in the given mode, or null if no switch should take
place. |
static IMemoryRenderingManager |
getMemoryRenderingManager()
Returns the memory rendering manager. |
static IPreferenceStore |
getPreferenceStore()
Returns the preference store for the debug UI plugin. |
static IResource |
getSelectedResource()
Returns the currently selected resource in the active workbench window, or null if none. |
static boolean |
isPrivate(ILaunchConfiguration configuration)
Returns whether the given launch configuraiton is private. |
static boolean |
isUseStepFilters()
Returns whether step filters are applied to step commands. |
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. |
static ISourceLookupResult |
lookupSource(Object artifact,
ISourceLocator locator)
Performs source lookup on the given artifact and returns the result. |
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)
Deprecated. use openLaunchConfigurationDialogOnGroup(Shell, IStructuredSelection, String) to specify the launch group that the dialog should be opened on. This method will open on the launch group with the specified mode and a null category |
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 int |
openLaunchConfigurationPropertiesDialog(Shell shell,
ILaunchConfiguration configuration,
String groupIdentifier,
IStatus status)
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. |
static void |
setLaunchPerspective(ILaunchConfigurationType type,
String mode,
String perspective)
Sets the perspective to switch to when a configuration of the given type is launched in the given mode. |
static void |
setUseStepFilters(boolean useStepFilters)
Sets whether step filters should be applied to step commands. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DebugUITools()
Method Detail |
public static Image getImage(String key)
null
if none.
Note that clients MUST NOT dispose the image returned by this method.
See IDebugUIConstants
for available images.
key
- the image key
null
if noneIDebugUIConstants
public static ImageDescriptor getImageDescriptor(String key)
null
if none.
See IDebugUIConstants
for available image descriptors.
key
- the image descriptor key
null
if noneIDebugUIConstants
public static ImageDescriptor getDefaultImageDescriptor(Object element)
null
if none is defined.
public static IPreferenceStore getPreferenceStore()
public static IDebugModelPresentation newDebugModelPresentation()
It is the client's responsibility dispose the presentation.
IBaseLabelProvider.dispose()
public static IDebugModelPresentation newDebugModelPresentation(String identifier)
null
if a presentation does
not exist.
It is the client's responsibility dispose the presentation.
identifier
- debug model identifier
null
IBaseLabelProvider.dispose()
public static IAdaptable getDebugContext()
null
if there is no current
debug context.
This method used to return null
when called from a non-UI thread,
but since 3.1, this methods also works when called from a non-UI thread.
null
public static IResource getSelectedResource()
null
if none. If an editor is active, the resource adapater
assocaited with the editor is returned, if any.
null
public static IProcess getCurrentProcess()
null
is returned.
null
public static int openLaunchConfigurationDialog(Shell shell, IStructuredSelection selection, String mode)
null
category
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.
shell
- the parent shell for the launch configuration dialogselection
- the initial selection for the dialogmode
- the mode (run or debug) in which to open the launch configuration dialog.
This should be one of the constants defined in ILaunchManager
.
Window.OK
or Window.CANCEL
public static int openLaunchConfigurationDialogOnGroup(Shell shell, IStructuredSelection selection, String groupIdentifier)
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.
shell
- the parent shell for the launch configuration dialogselection
- the initial selection for the dialoggroupIdentifier
- the identifier of the launch group to display (corresponds to
the identifier of a launch group extension)
Window.OK
or Window.CANCEL
public static int openLaunchConfigurationDialogOnGroup(Shell shell, IStructuredSelection selection, String groupIdentifier, IStatus status)
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.
shell
- the parent shell for the launch configuration dialogselection
- the initial selection for the dialoggroupIdentifier
- 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
Window.OK
or Window.CANCEL
IStatusHandler
public static int openLaunchConfigurationPropertiesDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier)
shell
- the parent shell for the launch configuration dialogconfiguration
- the configuration to displaygroupIdentifier
- group identifier of the launch group the launch configuration
belongs to
Window.OK
or Window.CANCEL
public static int openLaunchConfigurationPropertiesDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier, IStatus status)
shell
- the parent shell for the launch configuration dialogconfiguration
- the configuration to displaygroupIdentifier
- group identifier of the launch group the launch configuration
belongs tostatus
- the status to display, or null
if none
Window.OK
or Window.CANCEL
public static int openLaunchConfigurationDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier, IStatus status)
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.
shell
- the parent shell for the launch configuration dialogconfiguration
- the configuration to displaygroupIdentifier
- group identifier of the launch group the launch configuration
belongs tostatus
- the status to display, or null
if none
Window.OK
or Window.CANCEL
public static boolean saveAndBuildBeforeLaunch()
The following preferences effect whether dirty editors are saved, and/or if the user is prompted to save dirty edtiors:
public static boolean saveBeforeLaunch()
The following preferences effect whether dirty editors are saved, and/or if the user is prompted to save dirty edtiors:
public static void launch(ILaunchConfiguration configuration, String mode)
configuration
- the configuration to launchmode
- launch mode - run or debugpublic static ILaunch buildAndLaunch(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) throws CoreException
The following preference effects whether a build is performed before launching (if required):
configuration
- the configuration to launchmode
- the mode to launch inmonitor
- progress monitor
CoreException
- if building or launching failspublic static String getLaunchPerspective(ILaunchConfigurationType type, String mode)
null
if no switch should take
place.
type
- launch configuration typemode
- launch mode identifier
null
public static void setLaunchPerspective(ILaunchConfigurationType type, String mode, String perspective)
PERSPECTIVE_NONE
indicates no
perspective switch should take place. PERSPECTIVE_DEFAULT
indicates
a default perspective switch should take place, as defined by the associated
launch tab group extension.
type
- launch configuration typemode
- launch mode identifierperspective
- identifier, PERSPECTIVE_NONE
, or
PERSPECTIVE_DEFAULT
public static boolean isPrivate(ILaunchConfiguration configuration)
IDebugUIConstants.ATTR_PRIVATE
attribute.
configuration
- launch configuration
public static void setUseStepFilters(boolean useStepFilters)
useStepFilters
- whether step filters should be applied to step
commandsIStepFilters
public static boolean isUseStepFilters()
IStepFilters
public static IConsole getConsole(IProcess process)
null
if none.
process
- a process
null
if nonepublic static IConsole getConsole(IDebugElement element)
null
if none.
element
- a debug model element
null
if nonepublic static ILaunchGroup[] getLaunchGroups()
public static ILaunchGroup getLaunchGroup(ILaunchConfiguration configuration, String mode)
null
if none.
configuration
- mode
-
null
if nonepublic static ISourceLookupResult lookupSource(Object artifact, ISourceLocator locator)
artifact
- object for which source is to be resolvedlocator
- the source locator to use, or null
. When null
a source locator is determined from the artifact, if possible. If the artifact
is a debug element, the source locator from its associated launch is used.
public static void displaySource(ISourceLookupResult result, IWorkbenchPage page)
Honors user preference for editors re-use.
result
- source lookup result to displaypage
- the page to display the result inpublic static IMemoryRenderingManager getMemoryRenderingManager()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.