CNF导航----building-common-navigator-framework-viewer

Digital Paper Napkin

http://scribbledideas.blogspot.com/

The opinions and ideas expressed herin are my own and do not represent the intent, opinion, or official statement of any company or

organization.

All postings by me to this site are copyrighted (C) by Michael D. Elder, 2006 and made available under the terms of the Eclipse Public

License 1.0 with the constraint that any reuse of the content must contain this copyright statement.

Building a Common Navigator Framework (CNF) Viewer

I've started fielding questions about the Common Navigator on the eclipse.platform

newsgroup and the message from the community is resoundingly that there are not

enough examples. In order to help the community adopt the Common Navigator

framework, I'm going to be fleshing out some examples (in the Eclipse repo at

dev.eclipse.org:/home/eclipse, where you can login as "anonymous"; see the wiki for

more information. I will be documenting these examples here in this blog. Eventually I

will intgrate the documentation that evolves here back into the Platform SDK, but I want

a forum where potential consumers can provide feedback easily and directly to the

distribution media (e.g. this blog).

org.eclipse.ui.navigator. If you'd like more details on the specifics mentioned in this

post, please follow up with these references.

So where to begin? First we're going to configure our plugin that will contain the viewer

to add org.eclipse.ui.navigator to its dependencies. Then we're going to define a view

part using the org.eclipse.ui.views extension point and specify the

org.eclipse.ui.navigator.CommonNavigator class as our view part implementation,

Digital Paper Napkin

http://scribbledideas.blogspot.com/

The opinions and ideas expressed herin are my own and do not represent the intent, opinion, or official statement of any company or

organization.

All postings by me to this site are copyrighted (C) by Michael D. Elder, 2006 and made available under the terms of the Eclipse Public

License 1.0 with the constraint that any reuse of the content must contain this copyright statement.

which will provide a cradle for our viewer. Then we will define a

org.eclipse.ui.navigator.viewer extension to configure the viewer as a Common

Navigator. Finally, we can define org.eclipse.ui.navigator.navigatorContent

org.eclipse.ui.navigator.INavigatorContentService virtually anywhere from dialogs

to editors or define your own viewer and view part class, but for this example, we're

going to stick to the basics.

Basic Setup

The Common Navigator Framework is a feature that is new to Eclipse 3.2. Therefore,

you must have an update to Eclipse 3.2 environment installed. The topic of this post will

not get into setting up Eclipse for self-hosting development. I assume that you have

Eclipse 3.2 setup and are either self-hosting against a target of your own choice or the

Explorer, Package Explorer, Navigator, etc) and double-click or right-click and select

Open With> Plug-in Manifest Editor. On the Dependencies tab, click Add... and begin

typing org.eclipse.ui.navigator and select it when it is highlighted or when you see it

in the list.

Now select the Extensions tab of the editor.

Digital Paper Napkin

http://scribbledideas.blogspot.com/

The opinions and ideas expressed herin are my own and do not represent the intent, opinion, or official statement of any company or

organization.

All postings by me to this site are copyrighted (C) by Michael D. Elder, 2006 and made available under the terms of the Eclipse Public

License 1.0 with the constraint that any reuse of the content must contain this copyright statement.

Defining the View Part

When defining a Common Navigator enabled viewer, you must declare the actual view

You can define the view through the Extensions tab by selecting Add... and begin typing

org.eclipse.ui.views until you see it in the list. Then right-click on the entry that is

created under the "All Extensions" tree named org.eclipse.ui.views and choose New >

view. This will create the element in the plugin.xml file.

When you select the view element, the available attributes for the element should

appear as editable textboxes and widgets on the right. We are going to enter the

following values (without the quotes):

id: "org.eclipse.ui.examples.navigator.view"

following. You can choose to create a category as in the diagram, but be sure to indicate

which category your viewer should be associated with by specifying the "category"

attribute of the viewer. Otherwise, your viewer will appear in the Other category of the

Show View dialog (Window > Show View > Other...).