blob: b5fd652a2158ec2e7a4799a44a55b67addef1a70 [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>Launch Shortcuts</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.debug.ui.launchShortcuts<p>
<b><i>Description: </i></b>This extension point provides support for selection sensitive launching. Extensions register a shortcut which
appears in the run and/or debug cascade menus to launch the workbench selection or active editor.<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.shortcut">shortcut</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.shortcut">shortcut</a> (<a href="#e.perspective">perspective</a>*)&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST shortcut</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&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;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;&nbsp;&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;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;category&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;helpContextId&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - specifies a unique identifier for this launch shortcut.</li>
<li><b>modes</b> - specifies a comma-separated list of modes this shortcut supports.</li>
<li><b>class</b> - specifies the fully qualified name of a class which implements
<samp>org.eclipse.debug.ui.ILaunchShortcut</samp>.</li>
<li><b>label</b> - specifies a label used to render this shortcut.</li>
<li><b>icon</b> - specifies a plugin-relative path to an image used to render this shortcut.</li>
<li><b>category</b> - specifies the launch configuration type category this shortcut is applicable for. When unspecified, the category is null (default).</li>
<li><b>helpContextId</b> - an optional identifier that specifies the help context to associate with this launch shortcut</li>
</ul>
<p><samp><font color="#800000">&nbsp;&nbsp; &lt;!ELEMENT <a name="e.perspective">perspective</a> EMPTY&gt;</font></samp>
<br><br><samp><font color="#800000">&nbsp;&nbsp; &lt;!ATTLIST perspective</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</font></samp>
<ul>
<li><b>id</b> - the unique identifier of a perspective in which a menu shortcut for this launch shortcut will appear.</li>
</ul>
<b><i>Examples: </i></b>The following is an example of a launch shortcut extension point:
<p>
<pre>
<font color="#000080">&lt;extension point=<font color="#008000">&quot;org.eclipse.debug.ui.launchShortcuts&quot;</font>&gt;</font>
<font color="#000080">&lt;shortcut
id=<font color="#008000">&quot;com.example.ExampleLaunchShortcutId&quot;</font>
modes=<font color="#008000">&quot;run,debug&quot;</font>
class=<font color="#008000">&quot;com.example.ExampleLaunchShortcutImpl&quot;</font>
label=<font color="#008000">&quot;Example Launch Shortcut&quot;</font>
icon=<font color="#008000">&quot;icons/examples.gif&quot;</font>&gt;</font>
<font color="#000080">&lt;perspective id=<font color="#008000">&quot;org.eclipse.jdt.ui.JavaPerspective&quot;</font>/&gt;</font>
<font color="#000080">&lt;perspective id=<font color="#008000">&quot;org.eclipse.debug.ui.DebugPerspective&quot;</font>/&gt;</font>
<font color="#000080">&lt;/shortcut&gt;</font>
<font color="#000080">&lt;/extension&gt;</font>
</pre>
</p>
In the above example, a launch shortcut will be shown in the run and debug cascade menus with the label
"Example Launch Shortcut", in the JavaPerspective and the DebugPerspective.<p>
<b><i>API Information: </i></b>Value of the attribute <b>class</b> must be a fully qualified name of a Java class that implements the
interface <b>org.eclipse.debug.ui.ILaunchShortcut</b>.<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>