Views

Identifier:
org.eclipse.ui.views

Description:
This extension point is used to define additional views for the workbench. A view is a visual component within a workbench page. It is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor. The user can make a view visible from the Window > Show View menu or close it from the view local title bar.

In order to reduce the visual clutter in the Show View Dialog, views should be grouped using categories.

Configuration Markup:

<!ELEMENT extension (category | view | stickyView | e4view)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory IDREF #IMPLIED>

A category to group views in the UI.



<!ELEMENT view (description?)>

<!ATTLIST view

id                 CDATA #REQUIRED

name               CDATA #REQUIRED

category           IDREF #IMPLIED

class              CDATA #REQUIRED

icon               CDATA #IMPLIED

fastViewWidthRatio CDATA #IMPLIED

allowMultiple      (true | false)

restorable         (true | false) "true">

A view.



<!ELEMENT e4view (description?)>

<!ATTLIST e4view

id                 CDATA #REQUIRED

name               CDATA #REQUIRED

category           IDREF #IMPLIED

class              CDATA #REQUIRED

icon               CDATA #IMPLIED

fastViewWidthRatio CDATA #IMPLIED

allowMultiple      (true | false)

restorable         (true | false) "true">

An e4-style view.

Since: 3.105



<!ELEMENT description (#PCDATA)>

An optional subelement whose body should contain text providing a short description of the view.



<!ELEMENT stickyView EMPTY>

<!ATTLIST stickyView

id        IDREF #REQUIRED

location  (RIGHT|LEFT|TOP|BOTTOM)

closeable (true | false)

moveable  (true | false) >

A sticky view is a view that will appear by default across all perspectives in a window once it is opened. Its initial placement is governemed by the location attribute, but nothing prevents it from being moved or closed by the user. Use of this element will only cause a placeholder for the view to be created, it will not show the view. Please note that usage of this element should be done with great care and should only be applied to views that truely have a need to live across perspectives.

Since: 3.0



Examples:
The following is an example of the extension point:


   <extension point="org.eclipse.ui.views"> 
      <category 
         id="com.xyz.views.XYZviews" 
         name="XYZ"/> 
      <view 
         id="com.xyz.views.XYZView" 
         name="XYZ View" 
         category="com.xyz.views.XYZviews" 
         class="com.xyz.views.XYZView" 
         icon="icons/XYZ.png"/>
   </extension> 

The following is an example of a sticky view declaration:


   <extension point="org.eclipse.ui.views"> 
      <stickyView
         id="com.xyz.views.XYZView" />
   </extension> 

API Information:
The value of the view element's class attribute must be a fully qualified name of the class that implements org.eclipse.ui.IViewPart. It is common practice to subclass org.eclipse.ui.part.ViewPart when developing a new view.

Supplied Implementation:
The Eclipse Platform provides a number of standard views including Navigator, Properties, Outline and Tasks. From the user point of view, these views are no different from any other view provided by the plug-ins. All the views can be shown from the "Show View" submenu of the "Window" menu. The position of a view is persistent: it is saved when the view is closed and restored when the view is reopened in a single session. The position is also persisted between workbench sessions.


Copyright (c) 2002, 2013 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html