78
|
1 /*******************************************************************************
|
|
2 * Copyright (c) 2005, 2008 IBM Corporation and others.
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
5 * which accompanies this distribution, and is available at
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
7 *
|
|
8 * Contributors:
|
|
9 * IBM Corporation - initial API and implementation
|
|
10 *******************************************************************************/
|
|
11 module org.eclipse.jface.internal.databinding.provisional.swt.TableUpdater;
|
85
|
12 import org.eclipse.jface.internal.databinding.provisional.swt.SWTUtil;
|
78
|
13
|
|
14 import java.lang.all;
|
|
15
|
|
16 import org.eclipse.core.databinding.observable.ChangeEvent;
|
|
17 import org.eclipse.core.databinding.observable.IChangeListener;
|
|
18 import org.eclipse.core.databinding.observable.IObservable;
|
|
19 import org.eclipse.core.databinding.observable.ObservableTracker;
|
|
20 import org.eclipse.core.databinding.observable.list.IListChangeListener;
|
|
21 import org.eclipse.core.databinding.observable.list.IObservableList;
|
|
22 import org.eclipse.core.databinding.observable.list.ListChangeEvent;
|
|
23 import org.eclipse.core.databinding.observable.list.ListDiffEntry;
|
|
24 import org.eclipse.core.runtime.Assert;
|
|
25 import org.eclipse.swt.SWT;
|
|
26 import org.eclipse.swt.events.DisposeEvent;
|
|
27 import org.eclipse.swt.events.DisposeListener;
|
|
28 import org.eclipse.swt.widgets.Event;
|
|
29 import org.eclipse.swt.widgets.Listener;
|
|
30 import org.eclipse.swt.widgets.Table;
|
|
31 import org.eclipse.swt.widgets.TableItem;
|
|
32
|
|
33 /**
|
|
34 * NON-API - This class can be used to update a table with automatic dependency
|
|
35 * tracking.
|
|
36 *
|
|
37 * @since 1.1
|
|
38 *
|
|
39 * @noextend This class is not intended to be subclassed by clients. (We do
|
|
40 * encourage experimentation for non-production code and are
|
|
41 * interested in feedback though.)
|
|
42 *
|
|
43 */
|
|
44 public abstract class TableUpdater {
|
|
45
|
|
46 private class UpdateRunnable : Runnable, IChangeListener,
|
|
47 DisposeListener {
|
|
48 private TableItem item;
|
|
49
|
|
50 private bool dirty = false;
|
|
51
|
85
|
52 private IObservable[] dependencies;
|
78
|
53
|
|
54 private final Object element;
|
|
55
|
|
56 this(TableItem item, Object element) {
|
|
57 this.item = item;
|
|
58 this.element = element;
|
|
59 item.addDisposeListener(this);
|
|
60 }
|
|
61
|
|
62 // Runnable implementation. This method runs at most once per repaint
|
|
63 // whenever the
|
|
64 // value gets marked as dirty.
|
|
65 public void run() {
|
|
66 if (table !is null && !table.isDisposed() && item !is null
|
|
67 && !item.isDisposed()) {
|
|
68 if (table.isVisible()) {
|
|
69 int tableHeight = table.getClientArea().height;
|
|
70 int numVisibleItems = tableHeight / table.getItemHeight();
|
|
71 int indexOfItem = table.indexOf(item);
|
|
72 int topIndex = table.getTopIndex();
|
|
73 if (indexOfItem >= topIndex
|
|
74 && indexOfItem <= topIndex + numVisibleItems) {
|
|
75 updateIfNecessary(indexOfItem);
|
|
76 return;
|
|
77 }
|
|
78 }
|
|
79 table.clear(table.indexOf(item));
|
|
80 }
|
|
81 }
|
|
82
|
|
83 private void updateIfNecessary(int indexOfItem) {
|
|
84 if (dirty) {
|
|
85 dependencies = ObservableTracker.runAndMonitor(dgRunnable( (int indexOfItem_) {
|
|
86 updateItem(indexOfItem_, item, element);
|
|
87 }, indexOfItem), this, null);
|
|
88 dirty = false;
|
|
89 }
|
|
90 }
|
|
91
|
|
92 // IChangeListener implementation (listening to the ComputedValue)
|
|
93 public void handleChange(ChangeEvent event) {
|
|
94 // Whenever this updator becomes dirty, schedule the run() method
|
|
95 makeDirty();
|
|
96 }
|
|
97
|
|
98 protected final void makeDirty() {
|
|
99 if (!dirty) {
|
|
100 dirty = true;
|
|
101 stopListening();
|
|
102 SWTUtil.runOnce(table.getDisplay(), this);
|
|
103 }
|
|
104 }
|
|
105
|
|
106 private void stopListening() {
|
|
107 // Stop listening for dependency changes
|
|
108 for (int i = 0; i < dependencies.length; i++) {
|
|
109 IObservable observable = dependencies[i];
|
|
110
|
|
111 observable.removeChangeListener(this);
|
|
112 }
|
|
113 }
|
|
114
|
|
115 // DisposeListener implementation
|
|
116 public void widgetDisposed(DisposeEvent e) {
|
|
117 stopListening();
|
|
118 dependencies = null;
|
|
119 item = null;
|
|
120 }
|
|
121 }
|
|
122
|
|
123 private class PrivateInterface : Listener, DisposeListener {
|
|
124
|
|
125 // Listener implementation
|
|
126 public void handleEvent(Event e) {
|
|
127 if (e.type is SWT.SetData) {
|
|
128 UpdateRunnable runnable = cast(UpdateRunnable) e.item.getData();
|
|
129 if (runnable is null) {
|
|
130 runnable = new UpdateRunnable(cast(TableItem) e.item, list.get(e.index));
|
|
131 e.item.setData(runnable);
|
|
132 runnable.makeDirty();
|
|
133 } else {
|
|
134 runnable.updateIfNecessary(e.index);
|
|
135 }
|
|
136 }
|
|
137 }
|
|
138
|
|
139 // DisposeListener implementation
|
|
140 public void widgetDisposed(DisposeEvent e) {
|
|
141 this.outer.dispose();
|
|
142 }
|
|
143
|
|
144 }
|
|
145
|
85
|
146 private PrivateInterface privateInterface;
|
78
|
147
|
|
148 private Table table;
|
|
149
|
85
|
150 private IListChangeListener listChangeListener;
|
|
151 class ListChangeListener : IListChangeListener {
|
78
|
152 public void handleListChange(ListChangeEvent event) {
|
|
153 ListDiffEntry[] differences = event.diff.getDifferences();
|
|
154 for (int i = 0; i < differences.length; i++) {
|
|
155 ListDiffEntry entry = differences[i];
|
|
156 if (entry.isAddition()) {
|
|
157 TableItem item = new TableItem(table, SWT.NONE, entry
|
|
158 .getPosition());
|
|
159 UpdateRunnable updateRunnable = new UpdateRunnable(item, entry.getElement());
|
|
160 item.setData(updateRunnable);
|
|
161 updateRunnable.makeDirty();
|
|
162 } else {
|
|
163 table.getItem(entry.getPosition()).dispose();
|
|
164 }
|
|
165 }
|
|
166 }
|
|
167 };
|
|
168
|
|
169 private IObservableList list;
|
|
170
|
|
171 /**
|
|
172 * Creates an updator for the given control.
|
|
173 *
|
|
174 * @param table
|
|
175 * table to update
|
|
176 * @param list
|
|
177 * @since 1.2
|
|
178 */
|
|
179 public this(Table table, IObservableList list) {
|
85
|
180 privateInterface = new PrivateInterface();
|
|
181 listChangeListener = new ListChangeListener();
|
78
|
182 this.table = table;
|
|
183 this.list = list;
|
|
184 Assert.isLegal((table.getStyle() & SWT.VIRTUAL) !is 0,
|
|
185 "TableUpdater requires virtual table"); //$NON-NLS-1$
|
|
186
|
|
187 table.setItemCount(list.size());
|
|
188 list.addListChangeListener(listChangeListener);
|
|
189
|
|
190 table.addDisposeListener(privateInterface);
|
|
191 table.addListener(SWT.SetData, privateInterface);
|
|
192 }
|
|
193
|
|
194 /**
|
|
195 * This is called automatically when the control is disposed. It may also be
|
|
196 * called explicitly to remove this updator from the control. Subclasses
|
|
197 * will normally extend this method to detach any listeners they attached in
|
|
198 * their constructor.
|
|
199 */
|
|
200 public void dispose() {
|
|
201 table.removeDisposeListener(privateInterface);
|
85
|
202 table.removeListener(SWT.SetData, cast(Listener)privateInterface);
|
78
|
203 list.removeListChangeListener(listChangeListener);
|
|
204 table = null;
|
|
205 list = null;
|
|
206 }
|
|
207
|
|
208 /**
|
|
209 * Updates the control. This method will be invoked once after the updator
|
|
210 * is created, and once before any repaint during which the control is
|
|
211 * visible and dirty.
|
|
212 *
|
|
213 * <p>
|
|
214 * Subclasses should overload this method to provide any code that changes
|
|
215 * the appearance of the widget.
|
|
216 * </p>
|
|
217 *
|
|
218 * @param index
|
|
219 * @param item
|
|
220 * the item to update
|
|
221 * @param element
|
|
222 * @since 1.2
|
|
223 */
|
|
224 protected abstract void updateItem(int index, TableItem item, Object element);
|
|
225
|
|
226 }
|