blob: 3e1900095c5932d940dd32830798181336052bac [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
div.dtd-fragment {
width: 100%;
border: none;
background-color: #eee;
}
</STYLE>
</HEAD>
<HTML>
<BODY>
<H1><CENTER>Launcher (Obsolete)</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.core.launchers<p>
<b><i>Description: </i></b>This extension point has been replaced by the launchConfigurationTypes extension point. Extensions of this type are obsolete as of release 2.0 and are ignored. This extension point was used to contribute launchers.
A launcher was responsible for initiating a debug session
or running a program and registering the result with the
launch manager.<p><b><i>Configuration Markup:</i></b><p>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.launcher">launcher</a>*)&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST extension</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT <a name="e.launcher">launcher</a> EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST launcher</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;modes&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;label&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;wizard&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;perspective&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - a unique identifier that can be used to reference
this launcher.</li>
<li><b>class</b> - fully qualified name of the class that implements
<samp>org.eclipse.debug.core.model.ILauncherDelegate</samp>.</li>
<li><b>modes</b> - A comma separated list of modes this launcher supports.
The two supported modes are "run" and "debug" -
as defined in <samp>org.eclipse.debug.core.ILaunchManager</samp>.
A launcher may be capable of launching in one or both modes.</li>
<li><b>label</b> - a label to use for the launcher. This attribute is used by the debug UI.</li>
<li><b>wizard</b> - fully qualified name of the class that implements
<samp>org.eclipse.debug.ui.ILaunchWizard</samp>.
This attribute is used by the debug UI. A launcher
may contribute a wizard that allows users to configure
and launch specific attributes.</li>
<li><b>public</b> - whether a launcher is publically visible in the debug UI.
If "true", the launcher will be available from the
debug UI - the launcher will appear as a choice
for a default launcher, launches created by this
launcher will appear in the launch history, and the
launcher will be available from the drop-down run/debug
toolbar actions.</li>
<li><b>description</b> - a description of the launcher. Currently only used
if the wizard attribute is specified.</li>
<li><b>perspective</b> - the identifier of the perspective that will be switched
to on a successful launch. Default value is the
identifier for the debug perspective. This attribute
is used by the debug UI.</li>
<li><b>icon</b> - a relative path of an icon that will represent the launcher
in the UI if specified.</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a launcher extension point:
<p>
<pre>
<font color="#000080">&lt;extension
point = <font color="#008000">&quot;org.eclipse.debug.core.launchers&quot;</font>&gt;</font>
<font color="#000080">&lt;launcher
id = <font color="#008000">&quot;com.example.ExampleLauncher&quot;</font>
class = <font color="#008000">&quot;com.example.launchers.ExampleLauncher&quot;</font>
modes = <font color="#008000">&quot;run, debug&quot;</font>
label = <font color="#008000">&quot;Example Launcher&quot;</font>
wizard = <font color="#008000">&quot;com.example.launchers.ui.ExampleLaunchWizard&quot;</font>
public = <font color="#008000">&quot;true&quot;</font>
description = <font color="#008000">&quot;Launches example programs&quot;</font>
perspective= <font color="#008000">&quot;com.example.JavaPerspective&quot;</font>&gt;</font>
<font color="#000080">&lt;/launcher&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the example above, the specified launcher supports
both run and debug modes. Following a successful launch,
the debug UI will change to the Java perspective. When
the debug UI presents the user with a list of launchers
to choose from, "Example Launcher" will appear as one of
the choices with the "Launches example programs" as the
description, and the wizard specified by
<samp>com.example.launchers.ui.ExampleLaunchWizard</samp>
will be used to configure any launch specific details.<p>
<b><i>API Information: </i></b>Value of the attribute <samp>class</samp> must be a fully
qualified class name of a Java class that implements
the interface
<samp>org.eclipse.debug.core.ILauncherDelegate</samp>.
Value of the attribute <samp>wizard</samp> must be a
fully qualified class name of a Java class that
implements <samp>org.eclipse.debug.ui.ILaunchWizard</samp>.<p>
<font size="-1" color="#336699">
<p>
<a href="hglegal.htm">
<img SRC="ngibmcpy.gif"
ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved."
BORDER=0 height=14 width=324></a>
</p><p>
</font>
</BODY>
</HTML>