blob: b28be924d909d147b43d0d1d1b60aefc9b4cf9a1 [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">
</HEAD>
<HTML>
<BODY>
<H1><CENTER>Action Set Part Associations</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.ui.actionSetPartAssociations<p>
<b><i>Description: </i></b>This extension point is used to define an action set which should be added to a perspective when a part (view or editor) is opened in the perspective.
In the case of an editor, the action set will remain visible while the editor is the current editor.
In the case of a view, the action set will be visible when the view is the active part.<p><b><i>Configuration Markup:</i></b><p>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT extension (actionSetPartAssociation*)&gt;</samp>
<br><br><samp>&nbsp;&nbsp; &lt;!ATTLIST extension</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</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>&nbsp;&nbsp; &lt;!ELEMENT actionSetPartAssociation (part*)&gt;</samp>
<br><br><samp>&nbsp;&nbsp; &lt;!ATTLIST actionSetPartAssociation</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;targetID&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</samp>
<ul>
<li><b>targetID</b> - the unique identifier of the action set (as specified in the
registry) which is to be associated with particular workbench
views and/or editors.</li></ul>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT part EMPTY&gt;</samp>
<br><br><samp>&nbsp;&nbsp; &lt;!ATTLIST part</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</samp>
<ul>
<li><b>id</b> - the unique identifier of the part (view or editor) to be associated with the action set.</li></ul>
<b><i>Examples: </i></b>The following is an example of an action set part association (note the subelement and the way attributes are used):
<p>
<pre>
&lt;extension point=&quot;org.eclipse.ui.actionSetPartAssociations&quot;&gt;
&lt;actionSetPartAssociation targetID=&quot;org.eclipse.jdt.ui.refactoring.actionSet&quot;&gt;
&lt;part id=&quot;org.eclipse.jdt.ui.PackageExplorer&quot;/&gt;
&lt;part id=&quot;org.eclipse.jdt.ui.CompilationUnitError&quot;/&gt;
&lt;/actionSetPartAssociation&gt;
&lt;/extension&gt;
</pre>
</p>
In the example above, a view or editor are associated with the refactoring action set.<p>
<b><i>API Information: </i></b>The user may override these associations using the customize perspective dialog. Regardless of these associations,
action sets which the user turns off will never appear and action sets which the user turns on will always be visible.<p>
<p>
Copyright (c) 2002 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html<p>
</BODY>
</HTML>