1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/*******************************************************************************
* Copyright (c) 2011 Wind River Systems, Inc. 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
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.ui.trees;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.tcf.te.core.interfaces.IPropertyChangeProvider;
import org.eclipse.tcf.te.core.interfaces.IViewerInput;
/**
* The base tree content provider that defines several default methods.
*/
public abstract class TreeContentProvider implements ITreeContentProvider, PropertyChangeListener {
/**
* Static reference to the return value representing no elements.
*/
protected final static Object[] NO_ELEMENTS = new Object[0];
// The listener to refresh the common viewer when properties change.
protected CommonViewerListener commonViewerListener;
// The viewer inputs that have been added a property change listener.
private Set<IPropertyChangeProvider> providers = Collections.synchronizedSet(new HashSet<IPropertyChangeProvider>());
// The viewer
protected TreeViewer viewer;
// The pending nodes and their direct parents.
private Map<Object, Pending> pendings;
/**
* Create a tree content provider.
*/
public TreeContentProvider() {
pendings = new HashMap<Object, Pending>();
}
/**
* Get the pending node for the specified parent.
* If it exists, then return it. If not, create one
* and save it and return it.
*/
protected Pending getPending(Object parent) {
Pending pending = pendings.get(parent);
if(pending == null) {
pending = new Pending(viewer);
pendings.put(parent, pending);
}
return pending;
}
@Override
public void propertyChange(PropertyChangeEvent evt) {
String property = evt.getPropertyName();
if(property.equals("query_started")) { //$NON-NLS-1$
Object source = evt.getSource();
Pending pending = pendings.get(source);
if(pending != null) {
pending.startAnimation();
}
}
else if(property.equals("query_done")) { //$NON-NLS-1$
Object source = evt.getSource();
Pending pending = pendings.remove(source);
if(pending != null) {
pending.stopAnimation();
}
}
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.viewers.IContentProvider#dispose()
*/
@Override
public void dispose() {
for(IPropertyChangeProvider provider : providers) {
provider.removePropertyChangeListener(commonViewerListener);
provider.removePropertyChangeListener(this);
}
commonViewerListener.cancel();
providers.clear();
for(Pending pending : pendings.values()) {
pending.stopAnimation();
}
pendings.clear();
}
/**
* Get the filtered children of the parent using the
* filters registered in the viewer.
*
* @param parent The parent element.
* @return The children after filtering.
*/
private Object[] getFilteredChildren(Object parent) {
Object[] result = getChildren(parent);
if (viewer != null) {
ViewerFilter[] filters = viewer.getFilters();
if (filters != null) {
for (ViewerFilter filter : filters) {
Object[] filteredResult = filter.filter(viewer, parent, result);
result = filteredResult;
}
}
}
return result;
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object)
*/
@Override
public Object[] getChildren(Object parentElement) {
Assert.isNotNull(parentElement);
if (parentElement instanceof IAdaptable) {
IAdaptable adaptable = (IAdaptable) parentElement;
IViewerInput viewerInput = (IViewerInput) adaptable.getAdapter(IViewerInput.class);
if (viewerInput != null) {
installPropertyChangeListener(viewerInput);
}
}
return null;
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object)
*/
@Override
public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
Assert.isTrue(viewer instanceof TreeViewer);
this.viewer = (TreeViewer) viewer;
this.commonViewerListener = new CommonViewerListener(this.viewer, this);
}
/**
* Install a property change listener to the specified element.
*
* @param provider The element node.
*/
private void installPropertyChangeListener(IPropertyChangeProvider provider) {
if(provider != null && !providers.contains(provider) && commonViewerListener != null) {
provider.addPropertyChangeListener(commonViewerListener);
provider.addPropertyChangeListener(this);
providers.add(provider);
}
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.viewers.ITreeContentProvider#hasChildren(java.lang.Object)
*/
@Override
public boolean hasChildren(Object element) {
Object[] children = getFilteredChildren(element);
return children != null && children.length > 0;
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.viewers.ITreeContentProvider#getElements(java.lang.Object)
*/
@Override
public Object[] getElements(Object inputElement) {
return getChildren(inputElement);
}
}
|
