TreeViewer阶段性学习笔记1

 

公司接到了一个新项目，需要用到Eclipse插件开发，虽然Eclipse插件开发不是什么新技术了，但对项目组的所有成员来说还是一个新课题，因为都只是用Eclipse来开发，没有人做过插件开发。

新的程序员就是要随时接受技术挑战——“我能”！只不过是从头再来，再者说了，这还不是从头，至少我会些许的Java编程。

由于Eclipse插件开发涉及到的东西比较多，所以只能需要用什么就学什么，不然只是3、4个人按时交付项目是不可能了（好像现学已经不赶趟了）。

 

OK，新的工具需要一个树形的视图，树显示的内容类似“包资源管理器”，显示每一个工作空间中每一个项目，但是项目的结构与包资源管理器不同，需要按照自定义的结构来。

 

需要树形的视图，我就学TreeViewer，开始不了解什么Provider、什么Input，很奇怪；于是在当当上找了一本陈刚写的《Eclipse从入门到精通（第2版）》——这是我到现在看过的书名为“从入门到精通”最好的一本书了。

 

看了书，又在网上找了些资料后，终于搞明白了ContentProvider、LabelProvider、Input是什么关系了，并没有那么复杂。

 

ContentProvider、LabelProvider、Input

注意标题的顺序， 在编写程序时一定要把 TreeViewer 的 setInput 方法放在setContentProvider和setLabelProvider后调用，否则会。。。

程序执行，调用setInput方法后，Eclipse会找到ContentProvider的getElements方法，并将调用setInput时的参数塞过来；再根据getElements的返回结果去找LabelProvider的getText和getImage方法已取得在树中显示的文本和图标。

小例子

例子非常简单，就是显示一个再简单不过的树，如图：

 

1. 新建一个插件项目，名字为“test .tree ”，创建“test.tree.entry”和“test.tree.views”两个包；

2. 新建类：test.tree.views.TestContentProvider，源码：

public class TestContentProvider implements ITreeContentProvider {

	public Object[] getChildren(Object parentElement) {
		System.out.println("TestContentProvider1");
		return ((TestEntry) parentElement).getChildren().toArray();
	}

	public Object getParent(Object element) {
		System.out.println("TestContentProvider2");
		return ((TestEntry) element).getParent();
	}

	public boolean hasChildren(Object element) {
		System.out.println("TestContentProvider3");
		return ((TestEntry) element).hasChildren();
	}

	public Object[] getElements(Object inputElement) {
		System.out.println("TestContentProvider4");
		return ((List) inputElement).toArray();
	}

	public void dispose() {}
	public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {}
}

 

3. 新建类：test.tree.views.TestLabelProvider，源码：

public class TestLabelProvider implements ILabelProvider {

	public String getText(Object element) {
		System.out.println("TestLabelProvider1");
		return ((TestEntry) element).getName();
	}

	public Image getImage(Object element) {
		System.out.println("TestLabelProvider2");
		return null;
	}

	public void addListener(ILabelProviderListener listener) {}
	public void dispose() {}
	public boolean isLabelProperty(Object element, String property) {return false;}
	public void removeListener(ILabelProviderListener listener) {}
}

 

4. 新建类：test.tree.entry . TestEntry，源码：

public class TestEntry {
	
	private List<TestEntry> children;
	private TestEntry parent;
	private String name;
	
	public TestEntry(String name) {
		this.name = name;
	}
	
	public TestEntry(String name, List<TestEntry> children) {
		this.name = name;
		this.children = children;
		for (int i = 0; i < children.size(); i++) {
			children.get(i).setParent(this);
		}
	}
	
	public String getName() {
		return name;
	}
	
	public boolean hasChildren() {
		return children != null && children.size() > 0;
	}
	
	public List<TestEntry> getChildren() {
		return children;
	}
	
	public void setChildren(List<TestEntry> children) {
		this.children = children;
		for (int i = 0; i < children.size(); i++) {
			children.get(i).setParent(this);
		}
	}

	public TestEntry getParent() {
		return parent;
	}
	
	public void setParent(TestEntry parent) {
		this.parent = parent;
	}
}

 

5. 新建类：test.tree.views.TestInput，源码：

public class TestInput {
	
	public static List<TestEntry> example() {
		List<TestEntry> list1 = new ArrayList<TestEntry>();
		TestEntry t = new TestEntry("济南");
		list1.add(t);
		t = new TestEntry("青岛");
		list1.add(t);
		
		List<TestEntry> list2 = new ArrayList<TestEntry>();
		t = new TestEntry("山东", list1);
		list2.add(t);
		
		List<TestEntry> list3 = new ArrayList<TestEntry>();
		t = new TestEntry("中国", list2);
		list3.add(t);
		t = new TestEntry("印度");
		list3.add(t);
		
		return list3;
	}
}

 

6. 新建类：test.tree.views.TestView，源码：

public class TestView extends ViewPart {

	public void createPartControl(Composite parent) {
		TreeViewer tv = new TreeViewer(parent, SWT.NULL);
		tv.setContentProvider(new TestContentProvider());
		tv.setLabelProvider(new TestLabelProvider());
		tv.setInput(TestInput.example());
	}

	public void setFocus() {}
}

 

7. 最后还要配置一下plugin .xml:

<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.2"?>
<plugin>
   <extension
         point="org.eclipse.ui.views">
      <category
            id="com.aclyyx.test.tree.category1"
            name="Test Group"/>
      <view
            category="com.aclyyx.test.tree.category1"
            class="test.tree.views.TestView"
            id="test.tree.view1"
            name="Test TreeViewer"/>
   </extension>

</plugin>