How to create an Eclipse plug-in with JFace Tree

1. Create a plug-in named as “de.vogella.jface.treeviewer” by following the steps in the article http://www.vogella.de/articles/EclipsePlugIn/article.html#firstplugin. But select “Plug-in with a view” instead “Hello, World Command”in the last step.

2. Create all the classes mentioned in the article “Eclipse JFace Tree – Tutorial” http://www.vogella.de/articles/EclipseJFaceTree/article.html instead View.java.
3. You will not find a View.java in your plug-in project instead you will find “SampleView.java” in “de.vogella.jface.treeviewer.views” and run the project as an eclipse application.
package de.vogella.jface.treeviewer.views;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.part.*;
import org.eclipse.jface.viewers.*;
//import org.eclipse.swt.graphics.Image;
import org.eclipse.jface.action.*;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.ui.*;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.SWT;
import de.vogella.jface.treeviewer.model.TodoMockModel;
import de.vogella.jface.treeviewer.provider.TodoContentProvider;
import de.vogella.jface.treeviewer.provider.TodoLabelProvider;
/**
* This sample class demonstrates how to plug-in a new
* workbench view. The view shows data obtained from the
* model. The sample creates a dummy model on the fly,
* but a real implementation would connect to the model
* available either in this or another plug-in (e.g. the workspace).
* The view is connected to the model using a content provider.
*

* The view uses a label provider to define how model
* objects should be presented in the view. Each
* view can present the same model objects using
* different labels and icons, if needed. Alternatively,
* a single label provider can be shared between views
* in order to ensure that objects of the same type are
* presented in the same way everywhere.
*

*/
public class SampleView extends ViewPart {
/**
* The ID of the view as specified by the extension.
*/
public static final String ID = “de.vogella.jface.treeviewer.views.SampleView”;
private TreeViewer viewer;
private Action action1;
private Action action2;
private Action doubleClickAction;
/*
* The content provider class is responsible for
* providing objects to the view. It can wrap
* existing objects in adapters or simply return
* objects as-is. These objects may be sensitive
* to the current input of the view, or ignore
* it and always show the same content
* (like Task List, for example).
*/
// class ViewContentProvider implements IStructuredContentProvider {
// public void inputChanged(Viewer v, Object oldInput, Object newInput) {
// }
// public void dispose() {
// }
// public Object[] getElements(Object parent) {
// return new String[] { “One”, “Two”, “Three” };
// }
// }
// class ViewLabelProvider extends LabelProvider implements ITableLabelProvider {
// public String getColumnText(Object obj, int index) {
// return getText(obj);
// }
// public Image getColumnImage(Object obj, int index) {
// return getImage(obj);
// }
// public Image getImage(Object obj) {
// return PlatformUI.getWorkbench().
// getSharedImages().getImage(ISharedImages.IMG_OBJ_ELEMENT);
// }
// }
// class NameSorter extends ViewerSorter {
// }
/**
* The constructor.
*/
public SampleView() {
}
/**
* This is a callback that will allow us
* to create the viewer and initialize it.
*/
public void createPartControl(Composite parent) {
viewer = new TreeViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);
viewer.setContentProvider(new TodoContentProvider());
viewer.setLabelProvider(new TodoLabelProvider());
//viewer.setSorter(new NameSorter());
viewer.setAutoExpandLevel(2);
viewer.setInput(new TodoMockModel());
// Create the help context id for the viewer’s control
PlatformUI.getWorkbench().getHelpSystem().setHelp(viewer.getControl(), “de.vogella.jface.treeviewer.viewer”);
makeActions();
hookContextMenu();
hookDoubleClickAction();
contributeToActionBars();
}
private void hookContextMenu() {
MenuManager menuMgr = new MenuManager(“#PopupMenu”);
menuMgr.setRemoveAllWhenShown(true);
menuMgr.addMenuListener(new IMenuListener() {
public void menuAboutToShow(IMenuManager manager) {
SampleView.this.fillContextMenu(manager);
}
});
Menu menu = menuMgr.createContextMenu(viewer.getControl());
viewer.getControl().setMenu(menu);
getSite().registerContextMenu(menuMgr, viewer);
}
private void contributeToActionBars() {
IActionBars bars = getViewSite().getActionBars();
fillLocalPullDown(bars.getMenuManager());
fillLocalToolBar(bars.getToolBarManager());
}
private void fillLocalPullDown(IMenuManager manager) {
manager.add(action1);
manager.add(new Separator());
manager.add(action2);
}
private void fillContextMenu(IMenuManager manager) {
manager.add(action1);
manager.add(action2);
// Other plug-ins can contribute there actions here
manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
}
private void fillLocalToolBar(IToolBarManager manager) {
manager.add(action1);
manager.add(action2);
}
private void makeActions() {
action1 = new Action() {
public void run() {
showMessage(“Action 1 executed”);
}
};
action1.setText(“Action 1”);
action1.setToolTipText(“Action 1 tooltip”);
action1.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().
getImageDescriptor(ISharedImages.IMG_OBJS_INFO_TSK));
action2 = new Action() {
public void run() {
showMessage(“Action 2 executed”);
}
};
action2.setText(“Action 2”);
action2.setToolTipText(“Action 2 tooltip”);
action2.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().
getImageDescriptor(ISharedImages.IMG_OBJS_INFO_TSK));
doubleClickAction = new Action() {
public void run() {
ISelection selection = viewer.getSelection();
Object obj = ((IStructuredSelection)selection).getFirstElement();
showMessage(“Double-click detected on “+obj.toString());
}
};
}
private void hookDoubleClickAction() {
viewer.addDoubleClickListener(new IDoubleClickListener() {
public void doubleClick(DoubleClickEvent event) {
doubleClickAction.run();
}
});
}
private void showMessage(String message) {
MessageDialog.openInformation(
viewer.getControl().getShell(),
“Sample View”,
message);
}
/**
* Passing the focus request to the viewer’s control.
*/
public void setFocus() {
viewer.getControl().setFocus();
}
}

Advertisements

Author: Harshani Nawarathna

Sri Lankan woman in Computing

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s