Views
Identifier:
com.onaro.client.dashboard.ui.views
Since:
SANscreen 4.0
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)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - a unique name that will be used to identify this category
- name - a translatable name that will be used in the UI for this category
- parentCategory - an optional path composed of category IDs separated by '/'. This
allows the creation of a hierarchy of categories.
<!ELEMENT view (description?)>
<!ATTLIST view
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
class CDATA #REQUIRED
icon CDATA #IMPLIED
allowMultiple (true | false) >
- id - a unique name that will be used to identify this view
- name - a translatable name that will be used in the UI for this view
- category - an optional attribute that is composed of the category IDs separated
by '/'. Each referenced category must be declared in a corresponding category element.
- class - a fully qualified name of the class that implements
com.onaro.client.leekuihama.ui.IViewPart. A common practice
is to subclass com.onaro.client.leekuihama.ui.part.ViewPart
in order to inherit the default functionality.
- icon - a relative name of the icon that will
be associated with the view.
- allowMultiple - flag indicating whether this view allows multiple instances to be created using IWorkbenchPage.showView(String id, String secondaryId). The default is false.
<!ELEMENT description (#PCDATA)>
an optional subelement whose body should contain text providing a short description of the view.
Examples:
The following is an example of the extension point:
<extension point=
"com.onaro.client.dashboard.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.gif"
/>
</extension>
API Information:
The value of the class attribute must be a
fully qualified name of the class that implements
com.onaro.client.leekuihama.ui.IViewPart. It is common
practice to subclass com.onaro.client.leekuihama.ui.part.ViewPart
when developing a new view.
Copyright (c) 2002, 2005 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