| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <HTML> |
| <BODY> |
| <H1><CENTER>Launcher</CENTER></H1> |
| <b><i>Identifier: </i></b>org.eclipse.debug.core.launchers<p> |
| <b><i>Description: </i></b>This extension point allows tools to contribute launchers. |
| A launcher is 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"> <!ELEMENT extension (launcher*)></font></samp> |
| <br><br><samp><font color="#800000"> <!ATTLIST extension</samp> |
| <br><samp> point CDATA #REQUIRED</samp> |
| <br><samp> id CDATA #IMPLIED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></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"> <!ELEMENT launcher EMPTY></font></samp> |
| <br><br><samp><font color="#800000"> <!ATTLIST launcher</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> modes CDATA #REQUIRED</samp> |
| <br><samp> label CDATA #REQUIRED</samp> |
| <br><samp> wizard CDATA #IMPLIED</samp> |
| <br><samp> public (true | false) </samp> |
| <br><samp> description CDATA #IMPLIED</samp> |
| <br><samp> perspective CDATA #IMPLIED</samp> |
| <br><samp> icon CDATA #IMPLIED</samp> |
| <br><samp> ></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"><extension |
| point = <font color="#008000">"org.eclipse.debug.core.launchers"</font>></font> |
| <font color="#000080"><launcher |
| id = <font color="#008000">"com.example.ExampleLauncher"</font> |
| class = <font color="#008000">"com.example.launchers.ExampleLauncher"</font> |
| modes = <font color="#008000">"run, debug"</font> |
| label = <font color="#008000">"Example Launcher"</font> |
| wizard = <font color="#008000">"com.example.launchers.ui.ExampleLaunchWizard"</font> |
| public = <font color="#008000">"true"</font> |
| description = <font color="#008000">"Launches example programs"</font> |
| perspective= <font color="#008000">"com.example.JavaPerspective"</font>></font> |
| <font color="#000080"></launcher></font> |
| <font color="#000080"></extension></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"> |
| <a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a><p> |
| </font> |
| </BODY> |
| </HTML> |
