blob: 6338136fb59bdad850b8f0724fd8e737bcba3607 [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>Perspectives</CENTER></H1>
<b><i>Identifier: </i></b>org.eclipse.ui.perspective<p>
<b><i>Description: </i></b>This extension point is used to add perspective factories to the workbench. A perspective factory is used to define the initial layout and visible action sets for a perspective. The user can select a perspective by invoking the "Open Perspective" submenu of the "Window" menu.<p><b><i>Configuration Markup:</i></b><p>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT extension (perspective*)&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 perspective (description?)&gt;</samp>
<br><br><samp>&nbsp;&nbsp; &lt;!ATTLIST perspective</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;icon&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</samp>
<ul>
<li><b>id</b> - a unique name that will be used to identify this perspective.</li><li><b>name</b> - a translatable name that will be used in the workbench window menu bar to represent this perspective.</li><li><b>class</b> - a fully qualified name of the class that implements
<samp>org.eclipse.ui.IPerspectiveFactory</samp> interface.</li><li><b>icon</b> - a relative name of the icon that will be associated
with this perspective.</li></ul>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT description (#CDATA)&gt;</samp>
<p>&nbsp;&nbsp; an optional subelement whose body should contain text providing short description of the perspective.</p>
<b><i>Examples: </i></b>The following is an example of a perspective extension:
<p>
<pre>
&lt;extension
point=&quot;org.eclipse.ui.perspectives&quot;&gt;
&lt;perspective
id=&quot;org.eclipse.ui.resourcePerspective&quot;
name=&quot;Resource&quot;
class=&quot;org.eclipse.ui.internal.ResourcePerspective&quot;
icon=&quot;icons/MyIcon.gif&quot;&gt;
&lt;/perspective&gt;
&lt;/extension&gt;
</pre>
</p><p>
<b><i>API Information: </i></b>The value of the <samp>class</samp> attribute must be the
fully qualified name of a class that implements
<samp>org.eclipse.ui.IPerspectiveFactory</samp>.
The class must supply the initial layout for a
perspective when asked by the workbench.
<p>
The <samp>plugin_customization.ini</samp> file is used to define the default perspective. The <i>default perspective</i> is the first perspective which appears when the product is launched after install. It is also used when the user opens a page or window with no specified perspective. The default perspective is defined as a property within the plugin_customization.ini, as shown below. The user may also override this perspective from the workbench perspectives preference page.
<pre>
defaultPerspectiveId = org.eclipse.ui.resourcePerspective
</pre>
The perspectives which appear in the "Open Perspective" menu are shortcuts for perspective selection. This set is defined by the active perspective itself, and extensions made through the perspectiveExtensions extension point.<p>
<b><i>Supplied Implementation: </i></b>The workbench provides a "Resource Perspective".
Additional perspectives may be added by plug-ins.
They are selected using the "Open Perspective" submenu of the "Window" menu.<p>
Copyright (c) 2002, 2003 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>