diff options
24 files changed, 604 insertions, 270 deletions
diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_breakpoints.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_breakpoints.html index 6a3f9cd6e..e3e4e7432 100644 --- a/org.eclipse.debug.core/doc/org_eclipse_debug_core_breakpoints.html +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_breakpoints.html @@ -6,39 +6,47 @@ <H1><CENTER>Breakpoints</CENTER></H1> <b><i>Identifier: </i></b>org.eclipse.debug.core.breakpoints<p> <b><i>Description: </i></b>This extension point defines a mechanism for defining new types of breakpoints.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (breakpoint*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (breakpoint*)></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> ></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> <!ELEMENT breakpoint EMPTY></samp> -<br><br><samp> <!ATTLIST breakpoint</samp> +<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 breakpoint EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST breakpoint</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> markerType CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this breakpoint type.</li><li><b>markerType</b> - specifies the fully qualified identifier (id) of the corresponding marker definition for breakpoints of this type.</li><li><b>class</b> - specifies the fully qualified name of the java class that implements <samp>IBreakpoint</samp>.</li></ul> +<li><b>id</b> - specifies a unique identifier for this breakpoint type.</li> +<li><b>markerType</b> - specifies the fully qualified identifier (id) of the corresponding marker definition for breakpoints of this type.</li> +<li><b>class</b> - specifies the fully qualified name of the java class that implements <samp>IBreakpoint</samp>.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch configuration type extension point: <p> <pre> - <extension point="org.eclipse.debug.core.breakpoint"> - <breakpoint - id="com.example.ExampleBreakpoint" - markerType="com.example.ExampleBreakpointMarker" - class="com.example.ExampleBreakpointImpl"> - </breakpoint> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.core.breakpoint"</font>></font> + <font color="#000080"><breakpoint + id=<font color="#008000">"com.example.ExampleBreakpoint"</font> + markerType=<font color="#008000">"com.example.ExampleBreakpointMarker"</font> + class=<font color="#008000">"com.example.ExampleBreakpointImpl"</font>></font> + <font color="#000080"></breakpoint></font> + <font color="#000080"></extension></font> </pre> </p> In the example above, the specified type of breakpoint is implemented by the class "com.example.BreakpointImpl". There is an associated marker definition for "com.example.ExampleBreakpointMarker", defining the attributes of this breakpoint.<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.core.model.IBreakpoint</b>.<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> diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationComparators.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationComparators.html index 7f21181f6..f41206df6 100644 --- a/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationComparators.html +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationComparators.html @@ -9,38 +9,46 @@ In general, launch configuration attributes can be compared for equality via the default implementation of <samp>java.lang.Object.equals(Object)</samp>. However, attributes that require special handling should implement this extension point. For example, when an attribute is stored as XML, it is possible that two strings representing an equivalent attribute have different whitespace formatting.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (launchConfigurationComparator*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (launchConfigurationComparator*)></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> ></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> <!ELEMENT launchConfigurationComparator EMPTY></samp> -<br><br><samp> <!ATTLIST launchConfigurationComparator</samp> +<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 launchConfigurationComparator EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST launchConfigurationComparator</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> attribute CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this extension.</li><li><b>attribute</b> - specifies the launch configuration attribute name that this comparator compares.</li><li><b>class</b> - specifies a fully-qualified name of a class that implements <samp>java.util.Comparator</samp>.</li></ul> +<li><b>id</b> - specifies a unique identifier for this extension.</li> +<li><b>attribute</b> - specifies the launch configuration attribute name that this comparator compares.</li> +<li><b>class</b> - specifies a fully-qualified name of a class that implements <samp>java.util.Comparator</samp>.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch configuration comparator extension point: <p> <pre> - <extension point="org.eclipse.debug.core.launchConfigurationComparators"> - <launchConfigurationComparator - id="com.example.ExampleIdentifier" - attribute="com.example.ExampleAttributeName" - class="com.example.ComparatorImplementation"> - </launchConfigurationComparator> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.core.launchConfigurationComparators"</font>></font> + <font color="#000080"><launchConfigurationComparator + id=<font color="#008000">"com.example.ExampleIdentifier"</font> + attribute=<font color="#008000">"com.example.ExampleAttributeName"</font> + class=<font color="#008000">"com.example.ComparatorImplementation"</font>></font> + <font color="#000080"></launchConfigurationComparator></font> + <font color="#000080"></extension></font> </pre> </p> In the example above, the specified type of launch configuration comparator will be consulted when comparing the equality of attributes keyed with name <samp>com.example.ExampleAttributeName</samp>.<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>java.util.Comparator</b>.<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> diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationTypes.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationTypes.html index cc1ebb83c..e9f47f9fe 100644 --- a/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationTypes.html +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchConfigurationTypes.html @@ -8,54 +8,67 @@ <b><i>Description: </i></b>This extension point provides a configurable mechanism for launching applications. Each launch configuration type has a name, supports one or more modes (run and/or debug), and specifies a delegate responsible for the implementation of launching an application.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (launchConfigurationType*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (launchConfigurationType*)></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> ></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> <!ELEMENT launchConfigurationType (fileExtension+)></samp> -<br><br><samp> <!ATTLIST launchConfigurationType</samp> +<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 launchConfigurationType (fileExtension+)></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST launchConfigurationType</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> delegate CDATA #REQUIRED</samp> <br><samp> modes CDATA #REQUIRED</samp> <br><samp> name CDATA #REQUIRED</samp> -<br><samp> public (true | false) "false"#IMPLIED</samp> +<br><samp> public (true | false) </samp> <br><samp> category CDATA #IMPLIED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this launch configuration type.</li><li><b>delegate</b> - specifies the fully qualified name of the Java class that implements <samp>ILaunchConfigurationDelegate</samp>. -Launch configuration instances of this type will delegate to instances of this class to perform launching.</li><li><b>modes</b> - specifies a comma-separated list of the modes this type of lauch configuration supports - "run" and/or "debug".</li><li><b>name</b> - specifies a human-readable name for this type of launch configuration.</li><li><b>public</b> - specifies whether this launch configuration type is accessible by users. Defaults to true if not specified.</li><li><b>category</b> - an optional attribute that specifies this launch configuration type's category. The default value is unspecified (null). Categories are client defined. This attribute was added in the 2.1 release</li></ul> -<p><samp> <!ELEMENT fileExtension EMPTY></samp> -<br><br><samp> <!ATTLIST fileExtension</samp> +<li><b>id</b> - specifies a unique identifier for this launch configuration type.</li> +<li><b>delegate</b> - specifies the fully qualified name of the Java class that implements <samp>ILaunchConfigurationDelegate</samp>. +Launch configuration instances of this type will delegate to instances of this class to perform launching.</li> +<li><b>modes</b> - specifies a comma-separated list of the modes this type of lauch configuration supports - "run" and/or "debug".</li> +<li><b>name</b> - specifies a human-readable name for this type of launch configuration.</li> +<li><b>public</b> - specifies whether this launch configuration type is accessible by users. Defaults to true if not specified.</li> +<li><b>category</b> - an optional attribute that specifies this launch configuration type's category. The default value is unspecified (null). Categories are client defined. This attribute was added in the 2.1 release</li> +</ul> +<p><samp><font color="#800000"> <!ELEMENT fileExtension EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST fileExtension</samp> <br><samp> extension CDATA #REQUIRED</samp> -<br><samp> default (true | false) "false"#IMPLIED</samp> -<br><samp> ></samp> +<br><samp> default (true | false) </samp> +<br><samp> ></font></samp> <ul> <li><b>extension</b> - specifies a file extension that this launch configuration type -can be used for.</li><li><b>default</b> - specifies whether this launch configuration type should be the default launch configuration type for the specified file extension. Defaults to false if not specified.</li></ul> +can be used for.</li> +<li><b>default</b> - specifies whether this launch configuration type should be the default launch configuration type for the specified file extension. Defaults to false if not specified.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch configuration type extension point: <p> <pre> - <extension point="org.eclipse.debug.core.launchConfigurationTypes"> - <launchConfigurationType - id="com.example.ExampleIdentifier" - delegate="com.example.ExampleLaunchConfigurationDelegate" - modes="run,debug" - name="Example Application"> - <fileExtension extension="txt" default="true"/> - <fileExtension extension="gif" default="false"/> - </launchConfigurationType> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.core.launchConfigurationTypes"</font>></font> + <font color="#000080"><launchConfigurationType + id=<font color="#008000">"com.example.ExampleIdentifier"</font> + delegate=<font color="#008000">"com.example.ExampleLaunchConfigurationDelegate"</font> + modes=<font color="#008000">"run,debug"</font> + name=<font color="#008000">"Example Application"</font>></font> + <font color="#000080"><fileExtension extension=<font color="#008000">"txt"</font> default=<font color="#008000">"true"</font>/></font> + <font color="#000080"><fileExtension extension=<font color="#008000">"gif"</font> default=<font color="#008000">"false"</font>/></font> + <font color="#000080"></launchConfigurationType></font> + <font color="#000080"></extension></font> </pre> </p> In the example above, the specified type of launch configuration supports both run and debug modes. The launch configuration is applicable to .txt and .gif files, and is the default launch configuration for .txt files.<p> <b><i>API Information: </i></b>Value of the attribute <b>delegate</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.debug.core.model.ILaunchConfigurationDelegate</b>.<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> diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchers.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchers.html new file mode 100644 index 000000000..5856fdc24 --- /dev/null +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_launchers.html @@ -0,0 +1,104 @@ +<!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> diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_sourceLocators.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_sourceLocators.html index 1109d161c..24ba18188 100644 --- a/org.eclipse.debug.core/doc/org_eclipse_debug_core_sourceLocators.html +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_sourceLocators.html @@ -6,36 +6,44 @@ <H1><CENTER>Source Locators</CENTER></H1> <b><i>Identifier: </i></b>org.eclipse.debug.core.sourceLocators<p> <b><i>Description: </i></b>This extension point provides a mechanism specifying a source locator to be used with a launch configuration.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (sourceLocator*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (sourceLocator*)></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> ></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> <!ELEMENT sourceLocator EMPTY></samp> -<br><br><samp> <!ATTLIST sourceLocator</samp> +<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 sourceLocator EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST sourceLocator</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> <br><samp> name CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this source locator.</li><li><b>class</b> - specifies the fully qualified name of the Java class that implements IPersistableSourceLocator.</li><li><b>name</b> - a human-readable name, describing the type of this source locator.</li></ul> +<li><b>id</b> - specifies a unique identifier for this source locator.</li> +<li><b>class</b> - specifies the fully qualified name of the Java class that implements IPersistableSourceLocator.</li> +<li><b>name</b> - a human-readable name, describing the type of this source locator.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a source locator extension point: <p> <pre> - <extension point="org.eclipse.debug.core.sourceLocators"> - <sourceLocator - id="com.example.ExampleIdentifier" - class="com.example.ExampleSourceLocator" - name="Example Source Locator"> - </sourceLocator> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.core.sourceLocators"</font>></font> + <font color="#000080"><sourceLocator + id=<font color="#008000">"com.example.ExampleIdentifier"</font> + class=<font color="#008000">"com.example.ExampleSourceLocator"</font> + name=<font color="#008000">"Example Source Locator"</font>></font> + <font color="#000080"></sourceLocator></font> + <font color="#000080"></extension></font> </pre> </p><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.core.model.IPersistableSourceLocator</b>.<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> diff --git a/org.eclipse.debug.core/doc/org_eclipse_debug_core_statusHandlers.html b/org.eclipse.debug.core/doc/org_eclipse_debug_core_statusHandlers.html index bf1538caf..db9c1b9d7 100644 --- a/org.eclipse.debug.core/doc/org_eclipse_debug_core_statusHandlers.html +++ b/org.eclipse.debug.core/doc/org_eclipse_debug_core_statusHandlers.html @@ -8,41 +8,50 @@ <b><i>Description: </i></b>This extension point provides a mechanism for separating the generation and resolution of an error. The interaction between the source of the error and the resolution is client-defined. It is a client responsibility to look up and delegate to status handlers when an error condition occurs.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (statusHandler*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (statusHandler*)></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> ></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> <!ELEMENT statusHandler EMPTY></samp> -<br><br><samp> <!ATTLIST statusHandler</samp> +<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 statusHandler EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST statusHandler</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> <br><samp> plugin CDATA #REQUIRED</samp> <br><samp> code CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this status handler.</li><li><b>class</b> - specifies the fully qualified name of the Java class that implements IStatusHandler.</li><li><b>plugin</b> - Plug-in identifier that corresponds to the plug-in of the status this handler is registered for. (i.e. IStatus.getPlugin()).</li><li><b>code</b> - specifies the status code this handler is registered for.</li></ul> +<li><b>id</b> - specifies a unique identifier for this status handler.</li> +<li><b>class</b> - specifies the fully qualified name of the Java class that implements IStatusHandler.</li> +<li><b>plugin</b> - Plug-in identifier that corresponds to the plug-in of the status this handler is registered for. (i.e. IStatus.getPlugin()).</li> +<li><b>code</b> - specifies the status code this handler is registered for.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a status handler extension point: <p> <pre> - <extension point="org.eclipse.debug.core.statusHandlers"> - <statusHandler - id="com.example.ExampleIdentifier" - class="com.example.ExampleStatusHandler" - plugin="com.example.ExamplePluginId" - code="123"> - </statusHandler> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.core.statusHandlers"</font>></font> + <font color="#000080"><statusHandler + id=<font color="#008000">"com.example.ExampleIdentifier"</font> + class=<font color="#008000">"com.example.ExampleStatusHandler"</font> + plugin=<font color="#008000">"com.example.ExamplePluginId"</font> + code=<font color="#008000">"123"</font>></font> + <font color="#000080"></statusHandler></font> + <font color="#000080"></extension></font> </pre> </p> In the example above, the specified status handler will be registered for to handle status objects with a plug-in identifier of <samp>com.example.ExamplePluginId</samp> and a status code of <samp>123</samp>.<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.core.IStatusHandler</b>.<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> diff --git a/org.eclipse.debug.ui/.classpath b/org.eclipse.debug.ui/.classpath index a6861611e..a443939bc 100644 --- a/org.eclipse.debug.ui/.classpath +++ b/org.eclipse.debug.ui/.classpath @@ -7,6 +7,7 @@ <classpathentry kind="src" path="/org.eclipse.debug.core"/> <classpathentry kind="src" path="/org.eclipse.core.runtime"/> <classpathentry kind="src" path="/org.eclipse.core.boot"/> - <classpathentry kind="var" path="JRE_LIB" rootpath="JRE_SRCROOT" sourcepath="JRE_SRC"/> + <classpathentry kind="var" path="JRE_LIB" sourcepath="JRE_SRC"/> + <classpathentry kind="src" path="/org.eclipse.help"/> <classpathentry kind="output" path="bin"/> </classpath> diff --git a/org.eclipse.debug.ui/.project b/org.eclipse.debug.ui/.project index 976484b4a..45126b1cc 100644 --- a/org.eclipse.debug.ui/.project +++ b/org.eclipse.debug.ui/.project @@ -8,6 +8,7 @@ <project>org.eclipse.core.resources</project> <project>org.eclipse.core.runtime</project> <project>org.eclipse.debug.core</project> + <project>org.eclipse.help</project> <project>org.eclipse.ui</project> </projects> <buildSpec> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleColorProviders.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleColorProviders.html index c6493a170..afd28dc2f 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleColorProviders.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleColorProviders.html @@ -7,36 +7,44 @@ <b><i>Identifier: </i></b>org.eclipse.debug.ui.consoleColorProviders<p> <b><i>Since: </i></b>2.1<p> <b><i>Description: </i></b>This extension point provides a mechanism for contributing a console document coloring scheme for a process. The color provider will be used to color output in the console.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension EMPTY></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension EMPTY></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> ></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> <!ELEMENT consoleColorProvider EMPTY></samp> -<br><br><samp> <!ATTLIST consoleColorProvider</samp> +<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 consoleColorProvider EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST consoleColorProvider</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> <br><samp> processType CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this console color provider.</li><li><b>class</b> - specifies a fully qualified name of a Java class that implements IConsoleColorProvider</li><li><b>processType</b> - specifies the type of process this color provider is for. This attribute corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE.</li></ul> +<li><b>id</b> - specifies a unique identifier for this console color provider.</li> +<li><b>class</b> - specifies a fully qualified name of a Java class that implements IConsoleColorProvider</li> +<li><b>processType</b> - specifies the type of process this color provider is for. This attribute corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a console color provider extension point: <p> <pre> -<extension point="org.eclipse.debug.ui.consoleColorProviders"> - <consoleColorProvider - id="com.example.ExampleConsoleColorProvider" - class="com.example.ExampleConsoleColorProvider" - processType="ExampleProcessType"> - </consoleColorProvider> -</extension> +<font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.consoleColorProviders"</font>></font> + <font color="#000080"><consoleColorProvider + id=<font color="#008000">"com.example.ExampleConsoleColorProvider"</font> + class=<font color="#008000">"com.example.ExampleConsoleColorProvider"</font> + processType=<font color="#008000">"ExampleProcessType"</font>></font> + <font color="#000080"></consoleColorProvider></font> +<font color="#000080"></extension></font> </pre> In the above example, the contributed color provider will be used for processes of type "ExampleProcessType", which corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE. Process types are client defined, and are set by clients that create processes.<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.console.IConsoleColorProvider</b>.<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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleLineTrackers.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleLineTrackers.html index fc2cefac7..2955233c9 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleLineTrackers.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_consoleLineTrackers.html @@ -7,35 +7,43 @@ <b><i>Identifier: </i></b>org.eclipse.debug.ui.consoleLineTrackers<p> <b><i>Since: </i></b>2.1<p> <b><i>Description: </i></b>This extension point provides a mechanism to listen to console output for a type of process.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension EMPTY></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension EMPTY></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> ></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> <!ELEMENT consoleLineTracker EMPTY></samp> -<br><br><samp> <!ATTLIST consoleLineTracker</samp> +<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 consoleLineTracker EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST consoleLineTracker</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> class CDATA #REQUIRED</samp> <br><samp> processType CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this console line tracker.</li><li><b>class</b> - specifies a fully qualified name of a Java class that implements IConsoleLineTracker</li><li><b>processType</b> - specifies the type of process this line tracker is for. This attribute corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE.</li></ul> +<li><b>id</b> - specifies a unique identifier for this console line tracker.</li> +<li><b>class</b> - specifies a fully qualified name of a Java class that implements IConsoleLineTracker</li> +<li><b>processType</b> - specifies the type of process this line tracker is for. This attribute corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a console line tracker extension point: <pre> -<extension point="org.eclipse.debug.ui.consoleLineTrackers"> - <consoleLineTracker - id="com.example.ExampleConsoleLineTracker" - class="com.example.ExampleConsoleLineTracker" - processType="ExampleProcessType"> - </consoleLineTracker> -</extension> +<font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.consoleLineTrackers"</font>></font> + <font color="#000080"><consoleLineTracker + id=<font color="#008000">"com.example.ExampleConsoleLineTracker"</font> + class=<font color="#008000">"com.example.ExampleConsoleLineTracker"</font> + processType=<font color="#008000">"ExampleProcessType"</font>></font> + <font color="#000080"></consoleLineTracker></font> +<font color="#000080"></extension></font> </pre> In the above example, the contributed line tracker will be notified as lines are appended to the console for processes of type "ExampleProcessType", which corresponds to the process attribute IProcess.ATTR_PROCESS_TYPE. Process types are client defined, and are set by clients that create processes.<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.console.IConsoleLineTracker</b>.<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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugActionGroups.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugActionGroups.html index 6c6afed3d..03f35244a 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugActionGroups.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugActionGroups.html @@ -8,46 +8,55 @@ <b><i>Description: </i></b>This extension point provides a mechanism to specify the visibility of action groups. Any view that returns an instance of IDebugView when queried with #getAdapter(IDebugView.class) will have its context menu and toolbar affected by the visibility of the action groups.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (debugActionGroup*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (debugActionGroup*)></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> ></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> <!ELEMENT debugActionGroup (action*)></samp> -<br><br><samp> <!ATTLIST debugActionGroup</samp> +<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 debugActionGroup (action*)></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST debugActionGroup</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> name CDATA #REQUIRED</samp> -<br><samp> visible (true | false) "false"#IMPLIED</samp> -<br><samp> ></samp> +<br><samp> visible (true | false) </samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this debug action group.</li><li><b>name</b> - a translatable name that will be used for the debug action group label.</li><li><b>visible</b> - an optional attribute indicating the visibility of the group. If omitted, the group is set to be visible.</li></ul> -<p><samp> <!ELEMENT action EMPTY></samp> -<br><br><samp> <!ATTLIST action</samp> +<li><b>id</b> - specifies a unique identifier for this debug action group.</li> +<li><b>name</b> - a translatable name that will be used for the debug action group label.</li> +<li><b>visible</b> - an optional attribute indicating the visibility of the group. If omitted, the group is set to be visible.</li> +</ul> +<p><samp><font color="#800000"> <!ELEMENT action EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST action</samp> <br><samp> id CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - the unique identifier of an action that will be added to the debug action group.</li></ul> +<li><b>id</b> - the unique identifier of an action that will be added to the debug action group.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a debug action group extension point. In all debug views (views that return an instance of IDebugView when queried with #getAdapter(IDebugView.class)), the actions listed will not be visible in the toolbar or context menu of the view. <p> <pre> - <extension point="org.eclipse.debug.ui.debugActionGroups"> - <debugActionGroup - id="org.eclipse.jdt.debug.ui.javaDebugActionGroup" - visible="false" - name="Java Debug"> - <action id="org.eclipse.jdt.ui.actions.RunToLineToolbar"/> - <action id="org.eclipse.jdt.ui.breakpointViewActions.ShowQualified"/> - </debugActionGroup> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.debugActionGroups"</font>></font> + <font color="#000080"><debugActionGroup + id=<font color="#008000">"org.eclipse.jdt.debug.ui.javaDebugActionGroup"</font> + visible=<font color="#008000">"false"</font> + name=<font color="#008000">"Java Debug"</font>></font> + <font color="#000080"><action id=<font color="#008000">"org.eclipse.jdt.ui.actions.RunToLineToolbar"</font>/></font> + <font color="#000080"><action id=<font color="#008000">"org.eclipse.jdt.ui.breakpointViewActions.ShowQualified"</font>/></font> + <font color="#000080"></debugActionGroup></font> + <font color="#000080"></extension></font> </pre> </p><p> <b><i>Supplied Implementation: </i></b>Currently, the org.eclipse.jdt.debug.ui plugin provides the org.eclipse.jdt.debug.ui.javaDebugActionGroup<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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugModelPresentations.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugModelPresentations.html index 0c7378c76..3521528b8 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugModelPresentations.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_debugModelPresentations.html @@ -10,34 +10,40 @@ presentation aspects of a debug model. A debug model presentation is responsible for providing labels, images, and editors for elements in a specific debug model.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (debugModelPresentation*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (debugModelPresentation*)></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> ></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> <!ELEMENT debugModelPresentation EMPTY></samp> -<br><br><samp> <!ATTLIST debugModelPresentation</samp> +<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 debugModelPresentation EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST debugModelPresentation</samp> <br><samp> class CDATA #REQUIRED</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> detailsViewerConfiguration CDATA #IMPLIED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> <li><b>class</b> - fully qualifed name of a Java class that implements the <samp>org.eclipse.debug.ui.IDebugModelPresentation</samp> -interface.</li><li><b>id</b> - the identifier of the debug model this presentation is responsible for</li><li><b>detailsViewerConfiguration</b> - the fully qualified name of the Java class that is an instance of org.eclipse.jface.text.source.SourceViewerConfiguration. When specified, the source viewer configuration will be used in the "details" area of the variables and expressions view when displaying the details of an element from the debug model associated with this debug model presentation. When unspecified, a default configuration is used.</li></ul> +interface.</li> +<li><b>id</b> - the identifier of the debug model this presentation is responsible for</li> +<li><b>detailsViewerConfiguration</b> - the fully qualified name of the Java class that is an instance of org.eclipse.jface.text.source.SourceViewerConfiguration. When specified, the source viewer configuration will be used in the "details" area of the variables and expressions view when displaying the details of an element from the debug model associated with this debug model presentation. When unspecified, a default configuration is used.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a debug model presentations extension point: <p> <pre> - <extension point = "org.eclipse.debug.ui.debugModelPresentations"> - <debugModelPresentation - class = "com.example.JavaModelPresentation" - id = "com.example.JavaDebugModel" - </debugModelPresentation> - </extension> + <font color="#000080"><extension point = <font color="#008000">"org.eclipse.debug.ui.debugModelPresentations"</font>></font> + <font color="#000080"><debugModelPresentation + class = <font color="#008000">"com.example.JavaModelPresentation"</font> + id = <font color="#008000">"com.example.JavaDebugModel"</font> + <font color="#000080"></debugModelPresentation></font> + <font color="#000080"></extension></font> </pre> </p> In the example above, the class @@ -48,6 +54,8 @@ from the debug model identified by <b><i>API Information: </i></b>Value of the action attribute <samp>class</samp> must be a fully qualified class name of a Java class that implements <samp>org.eclipse.debug.ui.IDebugModelPresentation</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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTabGroups.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTabGroups.html index 871303af1..2c0678ed6 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTabGroups.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTabGroups.html @@ -7,34 +7,42 @@ <b><i>Identifier: </i></b>org.eclipse.debug.ui.launchConfigurationTabGroups<p> <b><i>Description: </i></b>This extension point provides a mechanism for contributing a group of tab to the launch configuration dialog for a type of launch configuration.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (launchConfigurationTabGroup*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (launchConfigurationTabGroup*)></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> ></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> <!ELEMENT launchConfigurationTabGroup EMPTY></samp> -<br><br><samp> <!ATTLIST launchConfigurationTabGroup</samp> -<br><samp> id CDATA #REQUIRED</samp> -<br><samp> type CDATA #REQUIRED</samp> -<br><samp> class CDATA #REQUIRED</samp> -<br><samp> ></samp> +<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 launchConfigurationTabGroup EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST launchConfigurationTabGroup</samp> +<br><samp> id CDATA #REQUIRED</samp> +<br><samp> type CDATA #REQUIRED</samp> +<br><samp> class CDATA #REQUIRED</samp> +<br><samp> helpContextId CDATA #IMPLIED</samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this launch configuration tab group.</li><li><b>type</b> - specifies a launch configuration type that this tab group is applicable to (corresponds to the id of a -launch configuration type extension).</li><li><b>class</b> - specifies a fully qualified name of a Java class that implements <samp>ILaunchConfigurationTabGroup</samp>.</li></ul> +<li><b>id</b> - specifies a unique identifier for this launch configuration tab group.</li> +<li><b>type</b> - specifies a launch configuration type that this tab group is applicable to (corresponds to the id of a +launch configuration type extension).</li> +<li><b>class</b> - specifies a fully qualified name of a Java class that implements <samp>ILaunchConfigurationTabGroup</samp>.</li> +<li><b>helpContextId</b> - an optional identifier that specifies the help context to associate with this tab group's launch configuration type</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch configuration tab group extension point: <p> <pre> - <extension point="org.eclipse.debug.ui.launchConfigurationTabGroups"> - <launchConfigurationTabGroup - id="com.example.ExampleTabGroup" - type="com.example.ExampleLaunchConfigurationTypeIdentifier" - class="com.example.ExampleLaunchConfigurationTabGroupClass"> - </launchConfigurationTabGroup> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.launchConfigurationTabGroups"</font>></font> + <font color="#000080"><launchConfigurationTabGroup + id=<font color="#008000">"com.example.ExampleTabGroup"</font> + type=<font color="#008000">"com.example.ExampleLaunchConfigurationTypeIdentifier"</font> + class=<font color="#008000">"com.example.ExampleLaunchConfigurationTabGroupClass"</font>></font> + <font color="#000080"></launchConfigurationTabGroup></font> + <font color="#000080"></extension></font> </pre> </p> @@ -42,6 +50,8 @@ In the above example, the contributed tab group will be shown for the launch con identifier <samp>com.example.ExampleLaunchConfigurationTypeIdentifier</samp>.<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.ILaunchConfigurationTabGroup</b>.<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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTypeImages.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTypeImages.html index 272b4d948..c1a8e6943 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTypeImages.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchConfigurationTypeImages.html @@ -6,35 +6,43 @@ <H1><CENTER>Launch Configuration Type Images</CENTER></H1> <b><i>Identifier: </i></b>org.eclipse.debug.ui.launchConfigurationTypeImages<p> <b><i>Description: </i></b>This extension point provides a way to associate an image with a launch configuration type.<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension (launchConfigurationTypeImage*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (launchConfigurationTypeImage*)></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> ></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> <!ELEMENT launchConfigurationTypeImage EMPTY></samp> -<br><br><samp> <!ATTLIST launchConfigurationTypeImage</samp> +<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 launchConfigurationTypeImage EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST launchConfigurationTypeImage</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> configTypeID CDATA #REQUIRED</samp> <br><samp> icon CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this launch configuration type image.</li><li><b>configTypeID</b> - specifies the fully qualified ID of a launch configuration type.(in 2.1, this attribute can also be specified using the "type" attribute, to be consistent with the launchConfigurationTabGroups extension point).</li><li><b>icon</b> - specifies the plugin-relative path of an image file.</li></ul> +<li><b>id</b> - specifies a unique identifier for this launch configuration type image.</li> +<li><b>configTypeID</b> - specifies the fully qualified ID of a launch configuration type.(in 2.1, this attribute can also be specified using the "type" attribute, to be consistent with the launchConfigurationTabGroups extension point).</li> +<li><b>icon</b> - specifies the plugin-relative path of an image file.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch configuration type image extension point: <p> <pre> - <extension point="org.eclipse.debug.ui.launchConfigurationTypeImages"> - <launchConfigurationTypeImage - id="com.example.FirstLaunchConfigurationTypeImage" - configTypeID="com.example.FirstLaunchConfigurationType" - icon="icons/FirstLaunchConfigurationType.gif"> - </launchConfigurationTypeImage> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.launchConfigurationTypeImages"</font>></font> + <font color="#000080"><launchConfigurationTypeImage + id=<font color="#008000">"com.example.FirstLaunchConfigurationTypeImage"</font> + configTypeID=<font color="#008000">"com.example.FirstLaunchConfigurationType"</font> + icon=<font color="#008000">"icons/FirstLaunchConfigurationType.gif"</font>></font> + <font color="#000080"></launchConfigurationTypeImage></font> + <font color="#000080"></extension></font> </pre> </p><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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchGroups.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchGroups.html index 6c25d41dc..f36405690 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchGroups.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchGroups.html @@ -7,16 +7,19 @@ <b><i>Identifier: </i></b>org.eclipse.debug.ui.launchGroups<p> <b><i>Since: </i></b>2.1<p> <b><i>Description: </i></b>This extension point provides support for defining a group of launch configurations to be viewed together in the launch configuration dialog, and support a launch history (recent and favorite launches).<p><b><i>Configuration Markup:</i></b><p> -<p><samp> <!ELEMENT extension EMPTY></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension EMPTY></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> ></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> <!ELEMENT launchGroup EMPTY></samp> -<br><br><samp> <!ATTLIST launchGroup</samp> +<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 launchGroup EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST launchGroup</samp> <br><samp> id CDATA #REQUIRED</samp> <br><samp> mode CDATA #REQUIRED</samp> <br><samp> category CDATA #IMPLIED</samp> @@ -24,24 +27,33 @@ <br><samp> image CDATA #REQUIRED</samp> <br><samp> bannerImage CDATA #REQUIRED</samp> <br><samp> public CDATA #IMPLIED</samp> -<br><samp> ></samp> +<br><samp> ></font></samp> <ul> -<li><b>id</b> - specifies a unique identifier for this launch group.</li><li><b>mode</b> - specifies the launch mode associated with this group - i.e. run or debug.</li><li><b>category</b> - specifies the category of launch configurations in this group. When unspecified, the category is null.</li><li><b>label</b> - specifies a translatable label used to render this group.</li><li><b>image</b> - specifies a plug-in relative path to an image used to render this group in trees, lists, tabs, etc.</li><li><b>bannerImage</b> - specifies a plug-in relative path to an image used to render this group in a wizard or dialog banner area.</li><li><b>public</b> - specifies whether this launch group is public and should be have a visible launch history tab in the debug preferences. The implied value is true, when not specified.</li></ul> +<li><b>id</b> - specifies a unique identifier for this launch group.</li> +<li><b>mode</b> - specifies the launch mode associated with this group - i.e. run or debug.</li> +<li><b>category</b> - specifies the category of launch configurations in this group. When unspecified, the category is null.</li> +<li><b>label</b> - specifies a translatable label used to render this group.</li> +<li><b>image</b> - specifies a plug-in relative path to an image used to render this group in trees, lists, tabs, etc.</li> +<li><b>bannerImage</b> - specifies a plug-in relative path to an image used to render this group in a wizard or dialog banner area.</li> +<li><b>public</b> - specifies whether this launch group is public and should be have a visible launch history tab in the debug preferences. The implied value is true, when not specified.</li> +</ul> <b><i>Examples: </i></b>The following is an example of a launch group extension point: <p> <pre> - <extension point="org.eclipse.debug.ui.launchGroups"> - <launchGroup - id="com.example.ExampleLaunchGroupId" - mode="run" - label="Run" - icon="icons\run.gif" - bannerImage="icons\runBanner.gif"> - </launchGroup> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.launchGroups"</font>></font> + <font color="#000080"><launchGroup + id=<font color="#008000">"com.example.ExampleLaunchGroupId"</font> + mode=<font color="#008000">"run"</font> + label=<font color="#008000">"Run"</font> + icon=<font color="#008000">"icons\run.gif"</font> + bannerImage=<font color="#008000">"icons\runBanner.gif"</font>></font> + <font color="#000080"></launchGroup></font> + <font color="#000080"></extension></font> </pre> </p> In the above example, the launch group will consist of all launch configurations with no category that support run mode.<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> diff --git a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchShortcuts.html b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchShortcuts.html index c6aca8b19..93a61eb3d 100644 --- a/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchShortcuts.html +++ b/org.eclipse.debug.ui/doc/org_eclipse_debug_ui_launchShortcuts.html @@ -7,47 +7,59 @@ <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> <!ELEMENT extension (shortcut*)></samp> -<br><br><samp> <!ATTLIST extension</samp> +<p><samp><font color="#800000"> <!ELEMENT extension (shortcut*)></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> ></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> <!ELEMENT shortcut (perspective*)></samp> -<br><br><samp> <!ATTLIST shortcut</samp> -<br><samp> id CDATA #REQUIRED</samp> -<br><samp> modes CDATA #REQUIRED</samp> -<br><samp> class CDATA #REQUIRED</samp> -<br><samp> label CDATA #REQUIRED</samp> -<br><samp> icon CDATA #REQUIRED</samp> -<br><samp> category CDATA #IMPLIED</samp> -<br><samp> ></samp> +<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 shortcut (perspective*)></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST shortcut</samp> +<br><samp> id CDATA #REQUIRED</samp> +<br><samp> modes CDATA #REQUIRED</samp> +<br><samp> class CDATA #REQUIRED</samp> +<br><samp> label CDATA #REQUIRED</samp> +<br><samp> icon CDATA #REQUIRED</samp> +<br><samp> category CDATA #IMPLIED</samp> +<br><samp> helpContextId CDATA #IMPLIED</samp> +<br><samp> ></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></ul> -<p><samp> <!ELEMENT perspective EMPTY></samp> -<br><br><samp> <!ATTLIST perspective</samp> +<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"> <!ELEMENT perspective EMPTY></font></samp> +<br><br><samp><font color="#800000"> <!ATTLIST perspective</samp> <br><samp> id CDATA #REQUIRED</samp> -<br><samp> ></samp> +<br><samp> ></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> +<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> - <extension point="org.eclipse.debug.ui.launchShortcuts"> - <shortcut - id="com.example.ExampleLaunchShortcutId" - modes="run,debug" - class="com.example.ExampleLaunchShortcutImpl" - label="Example Launch Shortcut" - icon="icons/examples.gif"> - <perspective id="org.eclipse.jdt.ui.JavaPerspective"/> - <perspective id="org.eclipse.debug.ui.DebugPerspective"/> - </shortcut> - </extension> + <font color="#000080"><extension point=<font color="#008000">"org.eclipse.debug.ui.launchShortcuts"</font>></font> + <font color="#000080"><shortcut + id=<font color="#008000">"com.example.ExampleLaunchShortcutId"</font> + modes=<font color="#008000">"run,debug"</font> + class=<font color="#008000">"com.example.ExampleLaunchShortcutImpl"</font> + label=<font color="#008000">"Example Launch Shortcut"</font> + icon=<font color="#008000">"icons/examples.gif"</font>></font> + <font color="#000080"><perspective id=<font color="#008000">"org.eclipse.jdt.ui.JavaPerspective"</font>/></font> + <font color="#000080"><perspective id=<font color="#008000">"org.eclipse.debug.ui.DebugPerspective"</font>/></font> + <font color="#000080"></shortcut></font> + <font color="#000080"></extension></font> </pre> </p> @@ -55,6 +67,8 @@ In the above example, a launch shortcut will be shown in the run and debug casca "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"> <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> diff --git a/org.eclipse.debug.ui/plugin.xml b/org.eclipse.debug.ui/plugin.xml index 18d9a1ace..7fa84bfce 100644 --- a/org.eclipse.debug.ui/plugin.xml +++ b/org.eclipse.debug.ui/plugin.xml @@ -18,6 +18,7 @@ <import plugin="org.apache.xerces"/> <import plugin="org.eclipse.core.resources"/> <import plugin="org.eclipse.ui"/> + <import plugin="org.eclipse.help"/> <import plugin="org.eclipse.debug.core"/> </requires> diff --git a/org.eclipse.debug.ui/schema/launchConfigurationTabGroups.exsd b/org.eclipse.debug.ui/schema/launchConfigurationTabGroups.exsd index 4fc17d67e..7cb96f0f4 100644 --- a/org.eclipse.debug.ui/schema/launchConfigurationTabGroups.exsd +++ b/org.eclipse.debug.ui/schema/launchConfigurationTabGroups.exsd @@ -2,14 +2,14 @@ <!-- Schema file written by PDE --> <schema targetNamespace="org.eclipse.debug.ui"> <annotation> - <appInfo> - <meta.schema plugin="org.eclipse.debug.ui" id="launchConfigurationTabGroups" name="Launch Configuration Tab Groups"/> - </appInfo> - <documentation> - This extension point provides a mechanism for contributing a group of tab to the launch configuration + <appInfo> + <meta.schema plugin="org.eclipse.debug.ui" id="launchConfigurationTabGroups" name="Launch Configuration Tab Groups"/> + </appInfo> + <documentation> + This extension point provides a mechanism for contributing a group of tab to the launch configuration dialog for a type of launch configuration. - </documentation> -</annotation> + </documentation> + </annotation> <element name="extension"> <complexType> @@ -33,7 +33,7 @@ dialog for a type of launch configuration. <attribute name="name" type="string"> <annotation> <documentation> - an optional name of the extension instance + an optional name of the extension instance </documentation> </annotation> </attribute> @@ -67,6 +67,13 @@ launch configuration type extension). </appInfo> </annotation> </attribute> + <attribute name="helpContextId" type="string"> + <annotation> + <documentation> + an optional identifier that specifies the help context to associate with this tab group's launch configuration type + </documentation> + </annotation> + </attribute> </complexType> </element> @@ -79,11 +86,11 @@ launch configuration type extension). <p> <pre> - <extension point="org.eclipse.debug.ui.launchConfigurationTabGroups"> + <extension point="org.eclipse.debug.ui.launchConfigurationTabGroups"> <launchConfigurationTabGroup - id="com.example.ExampleTabGroup" - type="com.example.ExampleLaunchConfigurationTypeIdentifier" - class="com.example.ExampleLaunchConfigurationTabGroupClass"> + id="com.example.ExampleTabGroup" + type="com.example.ExampleLaunchConfigurationTypeIdentifier" + class="com.example.ExampleLaunchConfigurationTabGroupClass"> </launchConfigurationTabGroup> </extension> </pre> @@ -109,7 +116,7 @@ interface <b>org.eclipse.debug.ui.ILaunchConfigurationTabGroup</b>. <meta.section type="copyright"/> </appInfo> <documentation> - <a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a> + <a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a> </documentation> </annotation> diff --git a/org.eclipse.debug.ui/schema/launchShortcuts.exsd b/org.eclipse.debug.ui/schema/launchShortcuts.exsd index 907cc8294..bc670838b 100644 --- a/org.eclipse.debug.ui/schema/launchShortcuts.exsd +++ b/org.eclipse.debug.ui/schema/launchShortcuts.exsd @@ -2,14 +2,14 @@ <!-- Schema file written by PDE --> <schema targetNamespace="org.eclipse.debug.ui"> <annotation> - <appInfo> - <meta.schema plugin="org.eclipse.debug.ui" id="launchShortcuts" name="Launch Shortcuts"/> - </appInfo> - <documentation> - This extension point provides support for selection sensitive launching. Extensions register a shortcut which + <appInfo> + <meta.schema plugin="org.eclipse.debug.ui" id="launchShortcuts" name="Launch Shortcuts"/> + </appInfo> + <documentation> + 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. - </documentation> -</annotation> + </documentation> + </annotation> <element name="extension"> <complexType> @@ -33,7 +33,7 @@ appears in the run and/or debug cascade menus to launch the workbench selection <attribute name="name" type="string"> <annotation> <documentation> - an optional name of the extension instance + an optional name of the extension instance </documentation> </annotation> </attribute> @@ -92,7 +92,7 @@ appears in the run and/or debug cascade menus to launch the workbench selection </appInfo> </annotation> </attribute> - <attribute name="category" type="string" use="optional"> + <attribute name="category" type="string"> <annotation> <documentation> specifies the launch configuration type category this shortcut is applicable for. When unspecified, the category is null (default). @@ -102,6 +102,13 @@ appears in the run and/or debug cascade menus to launch the workbench selection </appInfo> </annotation> </attribute> + <attribute name="helpContextId" type="string"> + <annotation> + <documentation> + an optional identifier that specifies the help context to associate with this launch shortcut + </documentation> + </annotation> + </attribute> </complexType> </element> @@ -126,26 +133,26 @@ appears in the run and/or debug cascade menus to launch the workbench selection <p> <pre> - <extension point="org.eclipse.debug.ui.launchShortcuts"> + <extension point="org.eclipse.debug.ui.launchShortcuts"> <shortcut - id="com.example.ExampleLaunchShortcutId" - modes="run,debug" - class="com.example.ExampleLaunchShortcutImpl" - label="Example Launch Shortcut" - icon="icons/examples.gif"> - <perspective id="org.eclipse.jdt.ui.JavaPerspective"/> - <perspective id="org.eclipse.debug.ui.DebugPerspective"/> + id="com.example.ExampleLaunchShortcutId" + modes="run,debug" + class="com.example.ExampleLaunchShortcutImpl" + label="Example Launch Shortcut" + icon="icons/examples.gif"> + <perspective id="org.eclipse.jdt.ui.JavaPerspective"/> + <perspective id="org.eclipse.debug.ui.DebugPerspective"/> </shortcut> </extension> </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. +"Example Launch Shortcut", in the JavaPerspective and the DebugPerspective. </documentation> </annotation> - <annotation> + <annotation> <appInfo> <meta.section type="apiInfo"/> </appInfo> @@ -154,13 +161,13 @@ In the above example, a launch shortcut will be shown in the run and debug casca interface <b>org.eclipse.debug.ui.ILaunchShortcut</b>. </documentation> </annotation> - + <annotation> <appInfo> <meta.section type="copyright"/> </appInfo> <documentation> - <a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a> + <a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2003. All Rights Reserved." BORDER=0 height=12 width=195></a> </documentation> </annotation> diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationPresentationManager.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationPresentationManager.java index 595e47d2e..cdf37850c 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationPresentationManager.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationPresentationManager.java @@ -105,8 +105,27 @@ public class LaunchConfigurationPresentationManager { throw new CoreException(status); } else { return ext.newTabGroup(); - } - + } + } + + /** + * Returns the identifier of the help context that is associated with the + * specified launch configuration type, or <code>null</code> if none. + * + * @return the identifier for the help context associated with the given + * type of launch configuration, or <code>null</code> + * @exception CoreException if an exception occurrs creating the group + * @since 2.1 + */ + public String getHelpContext(ILaunchConfigurationType type) throws CoreException { + LaunchConfigurationTabGroupExtension ext = (LaunchConfigurationTabGroupExtension)fTabGroupExtensions.get(type.getIdentifier()); + if (ext == null) { + IStatus status = new Status(IStatus.ERROR, IDebugUIConstants.PLUGIN_ID, IDebugUIConstants.INTERNAL_ERROR, + MessageFormat.format(LaunchConfigurationsMessages.getString("LaunchConfigurationPresentationManager.No_tab_group_defined_for_launch_configuration_type_{0}_3"), (new String[] {type.getIdentifier()})), null); ; //$NON-NLS-1$ + throw new CoreException(status); + } else { + return ext.getHelpContextId(); + } } } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationTabGroupExtension.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationTabGroupExtension.java index 3dda3b93d..c43b7ea2a 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationTabGroupExtension.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationTabGroupExtension.java @@ -76,6 +76,18 @@ public class LaunchConfigurationTabGroupExtension { } /** + * Returns the identifier of the help context associated with this tab + * group, or <code>null</code> if one was not specified. + * + * @return the identifier of this tab group's help context or + * <code>null</code> + * @since 2.1 + */ + protected String getHelpContextId() { + return getConfigurationElement().getAttribute("helpContextId"); //$NON-NLS-1$ + } + + /** * Returns a new tab group defined by this extension * * @return a new tab group defined by this extension diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationView.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationView.java index 9679803b2..da7b16470 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationView.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationView.java @@ -14,6 +14,7 @@ import org.eclipse.debug.core.ILaunchConfiguration; import org.eclipse.debug.core.ILaunchConfigurationListener; import org.eclipse.debug.core.ILaunchConfigurationType; import org.eclipse.debug.core.ILaunchManager; +import org.eclipse.debug.internal.ui.DebugUIPlugin; import org.eclipse.debug.internal.ui.IDebugHelpContextIds; import org.eclipse.debug.ui.AbstractDebugView; import org.eclipse.debug.ui.DebugUITools; @@ -21,11 +22,14 @@ import org.eclipse.debug.ui.IDebugView; import org.eclipse.jface.action.IMenuManager; import org.eclipse.jface.action.IToolBarManager; import org.eclipse.jface.action.Separator; +import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.jface.viewers.TreeViewer; import org.eclipse.jface.viewers.Viewer; +import org.eclipse.swt.events.HelpEvent; +import org.eclipse.swt.events.HelpListener; import org.eclipse.swt.events.KeyAdapter; import org.eclipse.swt.events.KeyEvent; import org.eclipse.swt.widgets.Composite; @@ -80,9 +84,47 @@ public class LaunchConfigurationView extends AbstractDebugView implements ILaunc treeViewer.addFilter(new LaunchGroupFilter(getLaunchGroup())); treeViewer.setInput(ResourcesPlugin.getWorkspace().getRoot()); treeViewer.expandAll(); + treeViewer.getControl().addHelpListener(new HelpListener() { + public void helpRequested(HelpEvent evt) { + handleHelpRequest(evt); + } + }); getLaunchManager().addLaunchConfigurationListener(this); return treeViewer; } + + /** + * Handle help events locally rather than deferring to WorkbenchHelp. This + * allows help specific to the selected config type to be presented. + * + * @since 2.1 + */ + protected void handleHelpRequest(HelpEvent evt) { + if (getTreeViewer().getTree() != evt.getSource()) { + return; + } + try { + ISelection selection = getViewer().getSelection(); + if (!selection.isEmpty() && selection instanceof IStructuredSelection ) { + IStructuredSelection structuredSelection = (IStructuredSelection) selection; + Object firstSelected = structuredSelection.getFirstElement(); + ILaunchConfigurationType configType = null; + if (firstSelected instanceof ILaunchConfigurationType) { + configType = (ILaunchConfigurationType) firstSelected; + } else if (firstSelected instanceof ILaunchConfiguration) { + configType = ((ILaunchConfiguration) firstSelected).getType(); + } + if (configType != null) { + String helpContextId = LaunchConfigurationPresentationManager.getDefault().getHelpContext(configType); + if (helpContextId != null) { + WorkbenchHelp.displayHelp(helpContextId); + } + } + } + } catch (CoreException ce) { + DebugUIPlugin.log(ce); + } + } /** * @see org.eclipse.debug.ui.AbstractDebugView#createActions() diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchShortcutExtension.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchShortcutExtension.java index 0a14b74ab..5468759da 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchShortcutExtension.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchShortcutExtension.java @@ -101,6 +101,18 @@ public class LaunchShortcutExtension implements ILaunchShortcut { } /** + * Returns the identifier of the help context associated with this launch + * shortcut, or <code>null</code> if one was not specified. + * + * @return the identifier of this launch shortcut's help context or + * <code>null</code> + * @since 2.1 + */ + public String getHelpContextId() { + return getConfigurationElement().getAttribute("helpContextId"); //$NON-NLS-1$ + } + + /** * Returns the category of this shortcut * * @return the category of this shortcut, or <code>null</code> if not diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/LaunchAsAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/LaunchAsAction.java index 73b784001..993b98c52 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/LaunchAsAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/LaunchAsAction.java @@ -28,6 +28,7 @@ import org.eclipse.ui.IPerspectiveDescriptor; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.IWorkbenchWindowPulldownDelegate2; +import org.eclipse.ui.help.WorkbenchHelp; //import org.eclipse.ui.internal.WWinKeyBindingService; //import org.eclipse.ui.internal.WorkbenchWindow; @@ -158,6 +159,10 @@ public class LaunchAsAction extends Action implements IMenuCreator, IWorkbenchWi private void populateMenu(LaunchShortcutExtension ext, Menu menu, int menuCount) { LaunchShortcutAction action = new LaunchShortcutAction(getMode(), ext); action.setActionDefinitionId(ext.getId()); + String helpContextId = ext.getHelpContextId(); + if (helpContextId != null) { + WorkbenchHelp.setHelp(action, helpContextId); + } /*if (fKeyBindingService != null) { fKeyBindingService.registerGlobalAction(action); }*/ |