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
189
190
191
|
/*******************************************************************************
* Copyright (c) 2008 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.ui.jface;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.jface.viewers.BaseLabelProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.LabelProviderChangedEvent;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.graphics.Image;
/**
* Implementation of {@link IStructuredContentProvider} and {@link ILabelProvider} that
* maintains a collection (Map, actually) of {@link ItemContentProvider}
* delegates that perform the function of providing content and label information
* for each represented item
*
* NB: This class, if used as a label provider *MUST* be used as a content provider
* for the same viewer. It may be used as a content provider with a different
* label provider, however.
*
* Provisional API: This class is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*/
public abstract class DelegatingContentAndLabelProvider extends BaseLabelProvider
implements IStructuredContentProvider, ILabelProvider
{
private final ItemContentProviderFactory itemContentProviderFactory;
private final ItemLabelProviderFactory itemLabelProviderFactory;
private final Map<Object, ItemContentProvider> itemContentProviders;
private final Map<Object, ItemLabelProvider> itemLabelProviders;
StructuredViewer viewer;
protected DelegatingContentAndLabelProvider(
ItemContentProviderFactory itemContentProviderFactory) {
this(itemContentProviderFactory, null);
}
protected DelegatingContentAndLabelProvider(
ItemContentProviderFactory itemContentProviderFactory,
ItemLabelProviderFactory itemLabelProviderFactory) {
super();
this.itemContentProviderFactory = itemContentProviderFactory;
this.itemLabelProviderFactory = itemLabelProviderFactory;
this.itemContentProviders = new HashMap<Object, ItemContentProvider>();
this.itemLabelProviders = new HashMap<Object, ItemLabelProvider>();
}
protected ItemContentProvider itemContentProvider(Object item) {
ItemContentProvider itemContentProvider = itemContentProviders.get(item);
if (itemContentProvider != null) {
return itemContentProvider;
}
itemContentProvider = itemContentProviderFactory.buildItemContentProvider(item, this);
if (itemContentProvider == null) {
return null;
}
itemContentProviders.put(item, itemContentProvider);
return itemContentProvider;
}
protected ItemLabelProvider itemLabelProvider(Object item) {
if (viewer == null) {
throw new IllegalStateException(
"This provider must be used as a content" +
"provider *as well as* a label provider.");
}
ItemLabelProvider itemLabelProvider = itemLabelProviders.get(item);
if (itemLabelProvider != null) {
return itemLabelProvider;
}
itemLabelProvider = itemLabelProviderFactory.buildItemLabelProvider(item, this);
if (itemLabelProvider == null) {
return null;
}
itemLabelProviders.put(item, itemLabelProvider);
return itemLabelProvider;
}
public Object[] getElements(Object inputElement) {
return itemContentProvider(inputElement).getElements();
}
public Image getImage(Object element) {
ItemLabelProvider provider = itemLabelProvider(element);
return (provider == null) ? null :provider.getImage();
}
public String getText(Object element) {
ItemLabelProvider provider = itemLabelProvider(element);
return (provider == null) ? null : provider.getText();
}
/**
* Disposes all items
*/
@Override
public void dispose() {
disposeProviders();
super.dispose();
}
protected void disposeProviders() {
// coded this way to allow some item providers to dispose of their child
// elements without disrupting the entire process
while (! itemContentProviders.isEmpty()) {
dispose(itemContentProviders.keySet().iterator().next());
}
// this catches any items that weren't disposed from the content providers,
// though there most likely won't be any items represented here that
// haven't already been disposed
while (! itemLabelProviders.isEmpty()) {
dispose(itemLabelProviders.keySet().iterator().next());
}
}
/**
* Disposes item
*/
public void dispose(Object item) {
if (itemContentProviders.containsKey(item)) {
itemContentProviders.get(item).dispose();
itemContentProviders.remove(item);
}
if (itemLabelProviders.containsKey(item)) {
itemLabelProviders.get(item).dispose();
itemLabelProviders.remove(item);
}
}
public void inputChanged(Viewer structuredViewer, Object oldInput, Object newInput) {
if (oldInput != newInput) {
disposeProviders();
}
this.viewer = (StructuredViewer) structuredViewer;
}
/**
* Update the content for the given item
*/
public void updateContent(final Object item) {
Runnable runnable = new Runnable() {
public void run() {
if (viewer != null && viewer.getControl() != null && !viewer.getControl().isDisposed()) {
viewer.refresh(item);
}
}
};
viewer.getControl().getDisplay().asyncExec(runnable);
}
// open up visibility a bit for inner classes
@Override
protected void fireLabelProviderChanged(LabelProviderChangedEvent event) {
super.fireLabelProviderChanged(event);
}
/**
* Update the label for the given item
*/
public void updateLabel(final Object item) {
Runnable runnable = new Runnable() {
public void run() {
if (viewer != null && viewer.getControl() != null && !viewer.getControl().isDisposed()) {
fireLabelProviderChanged(new LabelProviderChangedEvent(DelegatingContentAndLabelProvider.this, item));
}
}
};
viewer.getControl().getDisplay().asyncExec(runnable);
}
}
|
