blob: c2a2610eae942ccb7efd1e22679127f661ba48e4 [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">
<link rel="stylesheet" type="text/css" href="book.css"/>
<link rel="stylesheet" type="text/css" href="schema.css"/>
</HEAD>
<HTML>
<BODY>
<H1><CENTER>String Variable Presentations</CENTER></H1>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.debug.ui.stringVariablePresentations<p>
<h6 class=CaptionFigColumn id=header>Since: </h6>2.1<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>This extension point provides a mechanism for contributing a user interface/presentation for a string substitution variable (i.e. a context variable or value variable).<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&nbsp;&nbsp; &lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.variablePresentation">variablePresentation</a>*)&gt;</p>
<br><br><p class=code id=dtd>&nbsp;&nbsp; &lt;!ATTLIST extension</p>
<br><p class=code id=dtd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point&nbsp;CDATA #REQUIRED</p>
<br><p class=code id=dtd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>
<br><p class=code id=dtd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #IMPLIED</p>
<br><p class=code id=dtd>&nbsp;&nbsp; &gt;</p>
<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 class=code id=dtd>&nbsp;&nbsp; &lt;!ELEMENT <a name="e.variablePresentation">variablePresentation</a> EMPTY&gt;</p>
<br><br><p class=code id=dtd>&nbsp;&nbsp; &lt;!ATTLIST variablePresentation</p>
<br><p class=code id=dtd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variableName&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>
<br><p class=code id=dtd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;argumentSelector&nbsp;CDATA #REQUIRED</p>
<br><p class=code id=dtd>&nbsp;&nbsp; &gt;</p>
<ul>
<li><b>variableName</b> - specifies the variable this presentation is for</li>
<li><b>argumentSelector</b> - specifies a fully qualified name of a Java class that implements IArgumentSelector</li>
</ul>
<h6 class=CaptionFigColumn id=header>Examples: </h6>The following is an example of a variable presentation contribution:
<pre>
<p class=code id=tag>&lt;extension point=<p class=code id=cstring>&quot;org.eclipse.debug.ui.stringVariablePresentations&quot;</p><p class=code id=tag>&gt;</p>
<p class=code id=tag>&lt;variablePresentation
variableName=<p class=code id=cstring>&quot;example_variable&quot;</p><p class=code id=tag>
argumentSelector=<p class=code id=cstring>&quot;com.example.ExampleArgumentChooser&quot;</p><p class=code id=tag>&gt;</p>
<p class=code id=tag>&lt;/variablePresentation&gt;</p>
<p class=code id=tag>&lt;/extension&gt;</p>
</pre>
In the above example, the contributed presentation will be used for the variable named "example_variable". An argument selector is specified to configure an argument applicable to the variable.<p>
<h6 class=CaptionFigColumn id=header>API Information: </h6>Value of the attribute <b>argumentSelector</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.debug.ui.stringsubstitution.IArgumentSelector</b>.<p>
<h6 class=CaptionFigColumn id=copyright-text>
<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>
</h6>
</BODY>
</HTML>