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) 2006, 2009 IBM Corporation 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:
* IBM Corporation - initial API and implementation
* Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation
* fix for bug 163317, 201905
* Ralf Ebert - bug 294738
*******************************************************************************/
package org.eclipse.jface.viewers;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.util.Policy;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.widgets.Widget;
/**
* Instances of this class represent a column of a {@link ColumnViewer}. Label
* providers and editing support can be configured for each column separately.
* Concrete subclasses of {@link ColumnViewer} should implement a matching
* concrete subclass of {@link ViewerColumn}.
*
* @since 3.3
*
*/
public abstract class ViewerColumn {
private CellLabelProvider labelProvider;
static String COLUMN_VIEWER_KEY = Policy.JFACE + ".columnViewer";//$NON-NLS-1$
private EditingSupport editingSupport;
private ILabelProviderListener listener;
private boolean listenerRegistered = false;
private ColumnViewer viewer;
/**
* Create a new instance of the receiver at columnIndex.
*
* @param viewer
* the viewer the column is part of
* @param columnOwner
* the widget owning the viewer in case the widget has no columns
* this could be the widget itself
*/
protected ViewerColumn(final ColumnViewer viewer, Widget columnOwner) {
this.viewer = viewer;
columnOwner.setData(ViewerColumn.COLUMN_VIEWER_KEY, this);
this.listener = new ILabelProviderListener() {
public void labelProviderChanged(LabelProviderChangedEvent event) {
viewer.handleLabelProviderChanged(event);
}
};
columnOwner.addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent e) {
handleDispose(viewer);
}
});
}
/**
* Return the label provider for the receiver.
*
* @return ViewerLabelProvider
*/
/* package */CellLabelProvider getLabelProvider() {
return labelProvider;
}
/**
* Set the label provider for the column. Subclasses may extend but must
* call the super implementation.
*
* @param labelProvider
* the new {@link CellLabelProvider}
*/
public void setLabelProvider(CellLabelProvider labelProvider) {
setLabelProvider(labelProvider, true);
}
/**
* @param labelProvider
* @param registerListener
*/
/* package */void setLabelProvider(CellLabelProvider labelProvider,
boolean registerListener) {
if (listenerRegistered && this.labelProvider != null) {
this.labelProvider.removeListener(listener);
listenerRegistered = false;
if (registerListener) {
this.labelProvider.dispose(viewer, this);
}
}
this.labelProvider = labelProvider;
if (registerListener) {
this.labelProvider.initialize(viewer, this);
this.labelProvider.addListener(listener);
listenerRegistered = true;
}
}
/**
* Return the editing support for the receiver.
*
* @return {@link EditingSupport}
*/
/* package */EditingSupport getEditingSupport() {
return editingSupport;
}
/**
* Set the editing support. Subclasses may extend but must call the super
* implementation.
* <p>
* Users setting up an editable {@link TreeViewer} or {@link TableViewer} with more than 1 column <b>have</b>
* to pass the SWT.FULL_SELECTION style bit when creating the viewer
* </p>
* @param editingSupport
* The {@link EditingSupport} to set.
*/
public void setEditingSupport(EditingSupport editingSupport) {
this.editingSupport = editingSupport;
}
/**
* Refresh the cell for the given columnIndex. <strong>NOTE:</strong>the
* {@link ViewerCell} provided to this method is no longer valid after this
* method returns. Do not cache the cell for future use.
*
* @param cell
* {@link ViewerCell}
*/
/* package */void refresh(ViewerCell cell) {
CellLabelProvider labelProvider = getLabelProvider();
if (labelProvider == null) {
Assert.isTrue(false, "Column " + cell.getColumnIndex() + //$NON-NLS-1$
" has no label provider."); //$NON-NLS-1$
}
labelProvider.update(cell);
}
/**
* Disposes of the label provider (if set), unregisters the listener and
* nulls the references to the label provider and editing support. This
* method is called when the underlying widget is disposed. Subclasses may
* extend but must call the super implementation.
*/
protected void handleDispose() {
boolean disposeLabelProvider = listenerRegistered;
CellLabelProvider cellLabelProvider = labelProvider;
setLabelProvider(null, false);
if (disposeLabelProvider) {
cellLabelProvider.dispose(viewer, this);
}
editingSupport = null;
listener = null;
viewer = null;
}
private void handleDispose(ColumnViewer viewer) {
handleDispose();
viewer.clearLegacyEditingSetup();
}
/**
* Returns the viewer of this viewer column.
*
* @return Returns the viewer.
*
* @since 3.4
*/
public ColumnViewer getViewer() {
return viewer;
}
}
|
