《Eclipse插件开发》之列表查看器

本文为《eclipse插件开发学习笔记》的笔记，用于本人复习使用。
在查看器框架中，将模型称为输入，查看器本身充当控制器的角色，高级空间本身作为视图，当输入（模型）改变时，查看器负责相应的改变控件的内容。

• 模型和元素
  显示在查看器中的数据被称为元素，数据模型所维护的就是元素的集合

• 内容提供者
  一般情况下，外部程序无法直接提供查看器需要的模型，开发者需要自己解析模型并从其中取得查看器需要的内容，所有内容查看器都需要实现IContentProvider接口，列表查看器和表格查看器要求内容提供者实现IStructuredContentProvider接口，用于处理结构化数据的内容提供者，提供将模型转化成队列的接口。
  IContentProvider接口：inputChanged()
  当查看器使用了一个新的数据模型时（开发者调用了查看器的setInput方法），查看器会调用这个方法通知内容提供者，内容提供者开始监听新的数据模型。
  IStructuredContentProvider接口：getElements()
  在这个方法中，内容提供者需要所监听的数据模型翻译成一个元素数组返回，供查看器显示。

• 标签提供者
  得到元素的集合，将元素转化成可以显示的图片的文字。
  标签提供者需要实现IBaseLabelProvider。列表查看器使用子接口 ILabelProvider。
  IBaseLabelProvider接口:isLabelProperty(Object element,String property)
  判断element元素，property属性是否会用于显示，更新元素时，查看器会调用标签提供者的这个方法，有利于提高效率。

List Viewer

1. 所需JAR包
   org.eclipse.jface
   org.eclipse.core.commands
   org.eclipse.equinox.common

2. 步骤
   第一步：定义元素类，设计数据模型
   第二步：编写内容提供者，标签提供者
   第三步：创建控件
   第四步：创建查看器对象，将内容、标签提供者安装到查看器上并为查看器设定数据模型
   第五步：操作数据模型以在控件中显示希望的结果

3. 元素类

public class User {
    private String id;
    private String name;
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	@Override
	public String toString() {
		return "User [id=" + id + ", name=" + name + "]";
	}
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((id == null) ? 0 : id.hashCode());
		result = prime * result + ((name == null) ? 0 : name.hashCode());
		return result;
	}
	public User(String id, String name) {
		super();
		this.id = id;
		this.name = name;
	}
    
}

4. 模型类

public class ListModel {
	 public final static String NAME_ADD = "add";
	 public final static String NAME_REMOVE = "remove";
	 private List<Object> content = new ArrayList<Object>();
	 private PropertyChangeSupport mSupport = new PropertyChangeSupport(this);
	 //在模型上增加或删除一个对象时，模型都会发出相应的通知消息给已注册监听器，使用了PropertyChangeSupport类
	 public void add(Object element){
		 if(content.add(element)){
			 mSupport.firePropertyChange(NAME_ADD,null,element);
		 }
	 }
	 public void remove(Object element){
		 if(content.remove(element)){
			 mSupport.firePropertyChange(NAME_REMOVE, element, null);
		 }
	 }
	 //添加或移除对模型改变的监听器,向监听器列表添加一个或删除一个
	 public void addPropertyChageListener(PropertyChangeListener listener){
		 mSupport.addPropertyChangeListener(listener);
	 }
	 public void removePropertyChangeListeer(PropertyChangeListener listener){
		 mSupport.removePropertyChangeListener(listener);
	 }
	 //获得所有集合
	 public Object[] getElements(){
		 return content.toArray();
	 }

}

5. 内容提供者

@Override
	public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
		// TODO Auto-generated method stub
		//向数据模型注册监听器
		this.viewer = viewer;
		if(oldInput instanceof ListModel){
			((ListModel)oldInput).removePropertyChangeListeer(this);
		}
		if(newInput instanceof ListModel){
			((ListModel)newInput).addPropertyChageListener(this);
		}
	}

	@Override
	public Object[] getElements(Object inputElement) {
		// TODO Auto-generated method stub
		//列表查看器凑够新的模型中取得需要的元素数组
		if(inputElement instanceof ListModel){
			return ((ListModel)inputElement).getElements();
		}
		return new Object[0];
	}

	@Override
	public void propertyChange(PropertyChangeEvent evt) {
		// TODO Auto-generated method stub
		//内容提供者根据收到的通知内容，相应的向查看器上添加或删除元素
		if(ListModel.NAME_ADD.equals(evt.getPropertyName())){
			viewer.refresh();
		}
		if(ListModel.NAME_REMOVE.equals(evt.getPropertyName())){
			viewer.refresh();
		}
	}

6. 标签提供者

@Override
	public String getText(Object element) {
		// TODO Auto-generated method stub
		if(element instanceof User)
			return ((User)element).getName();
		return null;
	}

7. Viewer

public static void main(String[] args) {
		// TODO Auto-generated method stub
		Display display = Display.getDefault();
		final Shell shell = new Shell(display);
		shell.setText("Hello JFace");
		shell.setSize(560,383);
		shell.setLayout(new FillLayout());
		shell.open();
		
		ListViewer listViewer = new ListViewer(shell,SWT.BORDER);
		listViewer.setContentProvider(new ListContentProvider());
		listViewer.setLabelProvider(new ListLabelProvider());
		
		ListModel listmodel = new ListModel();
		listViewer.setInput(listmodel);
		
		listmodel.add(new User("1","Tom"));
		listmodel.add(new User("2","JACK"));
		listmodel.add(new User("3","Nancy"));
		
		
		while (!shell.isDisposed()){
			if(!display.readAndDispatch())
				display.sleep();
		}
		
	}