2010-10-15 Francois Chouinard <fchouinard@gmail.com> Fix for Bug327910
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / viewers / events / TmfEventsTable.java
CommitLineData
abfad0aa
FC
1/*******************************************************************************\r
2 * Copyright (c) 2010 Ericsson\r
3 * \r
4 * All rights reserved. This program and the accompanying materials are\r
5 * made available under the terms of the Eclipse Public License v1.0 which\r
6 * accompanies this distribution, and is available at\r
7 * http://www.eclipse.org/legal/epl-v10.html\r
8 * \r
9 * Contributors:\r
10 * Francois Chouinard - Initial API and implementation\r
11 * Patrick Tasse - Factored out from events view\r
9ccc6d01 12 * Francois Chouinard - Replaced Table by TmfVirtualTable\r
abfad0aa
FC
13 *******************************************************************************/\r
14\r
15package org.eclipse.linuxtools.tmf.ui.viewers.events;\r
16\r
529ee6a9
FC
17import org.eclipse.core.runtime.IProgressMonitor;\r
18import org.eclipse.core.runtime.IStatus;\r
19import org.eclipse.core.runtime.Status;\r
20import org.eclipse.core.runtime.jobs.Job;\r
abfad0aa
FC
21import org.eclipse.linuxtools.tmf.component.ITmfDataProvider;\r
22import org.eclipse.linuxtools.tmf.component.TmfComponent;\r
23import org.eclipse.linuxtools.tmf.event.TmfEvent;\r
24import org.eclipse.linuxtools.tmf.event.TmfTimestamp;\r
25import org.eclipse.linuxtools.tmf.request.TmfDataRequest;\r
26import org.eclipse.linuxtools.tmf.signal.TmfExperimentUpdatedSignal;\r
27import org.eclipse.linuxtools.tmf.signal.TmfRangeSynchSignal;\r
28import org.eclipse.linuxtools.tmf.signal.TmfSignalHandler;\r
29import org.eclipse.linuxtools.tmf.signal.TmfTimeSynchSignal;\r
30import org.eclipse.linuxtools.tmf.signal.TmfTraceUpdatedSignal;\r
31import org.eclipse.linuxtools.tmf.trace.ITmfTrace;\r
9ccc6d01
FC
32import org.eclipse.linuxtools.tmf.ui.widgets.ColumnData;\r
33import org.eclipse.linuxtools.tmf.ui.widgets.TmfVirtualTable;\r
abfad0aa
FC
34import org.eclipse.swt.SWT;\r
35import org.eclipse.swt.events.SelectionAdapter;\r
36import org.eclipse.swt.events.SelectionEvent;\r
37import org.eclipse.swt.layout.GridData;\r
38import org.eclipse.swt.widgets.Composite;\r
39import org.eclipse.swt.widgets.Event;\r
40import org.eclipse.swt.widgets.Listener;\r
abfad0aa
FC
41import org.eclipse.swt.widgets.TableColumn;\r
42import org.eclipse.swt.widgets.TableItem;\r
43\r
44/**\r
45 * <b><u>TmfEventsTable</u></b>\r
46 */\r
47public class TmfEventsTable extends TmfComponent {\r
48\r
abfad0aa
FC
49 // ------------------------------------------------------------------------\r
50 // Table data\r
51 // ------------------------------------------------------------------------\r
52\r
9ccc6d01 53 protected TmfVirtualTable fTable;\r
abfad0aa
FC
54 protected ITmfTrace fTrace;\r
55 protected boolean fPackDone = false;\r
56\r
57 // Table column names\r
529ee6a9
FC
58 static private final String TIMESTAMP_COLUMN = "Timestamp";\r
59 static private final String SOURCE_COLUMN = "Source";\r
60 static private final String TYPE_COLUMN = "Type";\r
61 static private final String REFERENCE_COLUMN = "File";\r
62 static private final String CONTENT_COLUMN = "Content";\r
63 static private final String[] COLUMN_NAMES = new String[] {\r
abfad0aa
FC
64 TIMESTAMP_COLUMN,\r
65 SOURCE_COLUMN,\r
66 TYPE_COLUMN,\r
67 REFERENCE_COLUMN,\r
68 CONTENT_COLUMN\r
69 };\r
70\r
529ee6a9
FC
71 static private ColumnData[] COLUMN_DATA = new ColumnData[] {\r
72 new ColumnData(COLUMN_NAMES[0], 100, SWT.LEFT),\r
73 new ColumnData(COLUMN_NAMES[1], 100, SWT.LEFT),\r
74 new ColumnData(COLUMN_NAMES[2], 100, SWT.LEFT),\r
75 new ColumnData(COLUMN_NAMES[3], 100, SWT.LEFT),\r
76 new ColumnData(COLUMN_NAMES[4], 100, SWT.LEFT)\r
abfad0aa
FC
77 };\r
78\r
79 // ------------------------------------------------------------------------\r
80 // Event cache\r
81 // ------------------------------------------------------------------------\r
82\r
9ccc6d01
FC
83 private final int fCacheSize;\r
84 private TmfEvent[] fCache;\r
85 private int fCacheStartIndex = 0;\r
86 private int fCacheEndIndex = 0;\r
87\r
529ee6a9 88 private boolean fDisposeOnClose;\r
abfad0aa
FC
89\r
90 // ------------------------------------------------------------------------\r
91 // Constructor\r
92 // ------------------------------------------------------------------------\r
93\r
94 public TmfEventsTable(Composite parent, int cacheSize) {\r
9ccc6d01
FC
95 this(parent, cacheSize, COLUMN_DATA);\r
96 }\r
97\r
98 public TmfEventsTable(Composite parent, int cacheSize, ColumnData[] columnData) {\r
abfad0aa
FC
99 super("TmfEventsTable");\r
100 \r
101 fCacheSize = cacheSize;\r
9ccc6d01 102 fCache = new TmfEvent[fCacheSize];\r
abfad0aa
FC
103 \r
104 // Create a virtual table\r
9ccc6d01
FC
105 final int style = SWT.SINGLE | SWT.FULL_SELECTION | SWT.BORDER;\r
106 fTable = new TmfVirtualTable(parent, style);\r
abfad0aa
FC
107\r
108 // Set the table layout\r
109 GridData layoutData = new GridData(SWT.FILL, SWT.FILL, true, true);\r
110 fTable.setLayoutData(layoutData);\r
111\r
112 // Some cosmetic enhancements\r
113 fTable.setHeaderVisible(true);\r
114 fTable.setLinesVisible(true);\r
115\r
116 // Set the columns\r
9ccc6d01 117 setColumnHeaders(columnData);\r
abfad0aa
FC
118\r
119 // Handle the table item requests \r
120 fTable.addSelectionListener(new SelectionAdapter() {\r
abfad0aa
FC
121 @Override\r
122 public void widgetSelected(SelectionEvent e) {\r
123 TmfTimestamp ts = (TmfTimestamp) fTable.getSelection()[0].getData();\r
124 broadcast(new TmfTimeSynchSignal(fTable, ts));\r
125 }\r
126 });\r
127\r
128 // Handle the table item requests \r
129 fTable.addListener(SWT.SetData, new Listener() {\r
130\r
131 @SuppressWarnings("unchecked")\r
132 public void handleEvent(Event event) {\r
133\r
134 final TableItem item = (TableItem) event.item;\r
135 final int index = fTable.indexOf(item);\r
136\r
137 // Note: this works because handleEvent() is called once for each row, in sequence \r
9ccc6d01
FC
138 if ((index >= fCacheStartIndex) && (index < fCacheEndIndex)) {\r
139 int i = index - fCacheStartIndex;\r
140 item.setText(extractItemFields(fCache[i]));\r
141 item.setData(new TmfTimestamp(fCache[i].getTimestamp()));\r
abfad0aa
FC
142 return;\r
143 }\r
144\r
f9673903
FC
145 fCacheStartIndex = index;\r
146 fCacheEndIndex = index;\r
147\r
abfad0aa 148 TmfDataRequest<TmfEvent> request = new TmfDataRequest<TmfEvent>(TmfEvent.class, index, fCacheSize) {\r
f9673903
FC
149 private int count = 0;\r
150\r
151 @Override\r
152 public void handleData(TmfEvent event) {\r
153 super.handleData(event);\r
154 if (event != null) {\r
155 fCache[count++] = event.clone();\r
156 fCacheEndIndex++;\r
abfad0aa
FC
157 }\r
158 }\r
f9673903 159\r
abfad0aa 160 };\r
f9673903 161\r
abfad0aa
FC
162 ((ITmfDataProvider<TmfEvent>) fTrace).sendRequest(request);\r
163 try {\r
164 request.waitForCompletion();\r
165 } catch (InterruptedException e) {\r
166 e.printStackTrace();\r
167 }\r
168 \r
9ccc6d01
FC
169 if (fCache[0] != null && fCacheStartIndex == index) {\r
170 item.setText(extractItemFields(fCache[0]));\r
171 item.setData(new TmfTimestamp(fCache[0].getTimestamp()));\r
172 packColumns();\r
abfad0aa
FC
173 }\r
174 \r
175 }\r
176 });\r
177\r
178 fTable.setItemCount(0);\r
179 }\r
180\r
9ccc6d01
FC
181 @Override\r
182 public void dispose() {\r
abfad0aa 183 fTable.dispose();\r
529ee6a9 184 if (fTrace != null && fDisposeOnClose) {\r
abfad0aa
FC
185 fTrace.dispose();\r
186 }\r
187 super.dispose();\r
188 }\r
189\r
9ccc6d01 190 public TmfVirtualTable getTable() {\r
abfad0aa
FC
191 return fTable;\r
192 }\r
193 \r
194 /**\r
195 * @param table\r
196 * \r
197 * FIXME: Add support for column selection\r
198 */\r
9ccc6d01
FC
199 protected void setColumnHeaders(ColumnData[] columnData) {\r
200 fTable.setColumnHeaders(columnData);\r
abfad0aa
FC
201 }\r
202\r
9ccc6d01 203 protected void packColumns() {\r
abfad0aa
FC
204 if (fPackDone) return;\r
205 for (TableColumn column : fTable.getColumns()) {\r
206 int headerWidth = column.getWidth();\r
207 column.pack();\r
208 if (column.getWidth() < headerWidth) {\r
209 column.setWidth(headerWidth);\r
210 }\r
211 }\r
212 fPackDone = true;\r
213 }\r
214 \r
215 /**\r
216 * @param event\r
217 * @return\r
218 * \r
219 * FIXME: Add support for column selection\r
220 */\r
78c0de16 221 protected String[] extractItemFields(TmfEvent event) {\r
abfad0aa
FC
222 String[] fields = new String[0];\r
223 if (event != null) {\r
224 fields = new String[] {\r
225 new Long(event.getTimestamp().getValue()).toString(), \r
226 event.getSource().getSourceId().toString(),\r
227 event.getType().getTypeId().toString(),\r
228 event.getReference().getReference().toString(),\r
229 event.getContent().toString()\r
230 };\r
231 }\r
232 return fields;\r
233 }\r
234\r
235 public void setFocus() {\r
236 fTable.setFocus();\r
237 }\r
238\r
529ee6a9
FC
239 /**\r
240 * @param trace\r
241 * @param disposeOnClose true if the trace should be disposed when the table is disposed\r
242 */\r
243 public void setTrace(ITmfTrace trace, boolean disposeOnClose) {\r
244 if (fTrace != null && fDisposeOnClose) {\r
245 fTrace.dispose();\r
246 }\r
abfad0aa 247 fTrace = trace;\r
529ee6a9 248 fDisposeOnClose = disposeOnClose;\r
abfad0aa
FC
249 \r
250 // Perform the updates on the UI thread\r
251 fTable.getDisplay().syncExec(new Runnable() {\r
252 public void run() {\r
529ee6a9 253 //fTable.setSelection(0);\r
abfad0aa 254 fTable.removeAll();\r
9ccc6d01 255 fCacheStartIndex = fCacheEndIndex = 0; // Clear the cache\r
abfad0aa
FC
256 \r
257 if (!fTable.isDisposed() && fTrace != null) {\r
258 //int nbEvents = (int) fTrace.getNbEvents();\r
259 //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);\r
260 fTable.setItemCount((int) fTrace.getNbEvents());\r
261 }\r
262 }\r
263 });\r
abfad0aa
FC
264 }\r
265\r
266 // ------------------------------------------------------------------------\r
267 // Signal handlers\r
268 // ------------------------------------------------------------------------\r
269 \r
270 @TmfSignalHandler\r
271 public void experimentUpdated(TmfExperimentUpdatedSignal signal) {\r
db1ea19b 272 if ((signal.getExperiment() != fTrace) || fTable.isDisposed()) return;\r
abfad0aa
FC
273 // Perform the refresh on the UI thread\r
274 fTable.getDisplay().asyncExec(new Runnable() {\r
275 public void run() {\r
276 if (!fTable.isDisposed() && fTrace != null) {\r
277 fTable.setItemCount((int) fTrace.getNbEvents());\r
9ccc6d01 278 fTable.refresh();\r
abfad0aa
FC
279 }\r
280 }\r
281 });\r
282 }\r
283 \r
284 @TmfSignalHandler\r
285 public void traceUpdated(TmfTraceUpdatedSignal signal) {\r
db1ea19b 286 if ((signal.getTrace() != fTrace ) || fTable.isDisposed()) return;\r
abfad0aa
FC
287 // Perform the refresh on the UI thread\r
288 fTable.getDisplay().asyncExec(new Runnable() {\r
289 public void run() {\r
290 if (!fTable.isDisposed() && fTrace != null) {\r
291 //int nbEvents = (int) fTrace.getNbEvents();\r
292 //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);\r
293 fTable.setItemCount((int) fTrace.getNbEvents());\r
294 }\r
295 }\r
296 });\r
297 }\r
298\r
299 private boolean fRefreshPending = false;\r
300 @TmfSignalHandler\r
301 public synchronized void rangeSynched(TmfRangeSynchSignal signal) {\r
db1ea19b 302 if (!fRefreshPending && !fTable.isDisposed()) {\r
abfad0aa
FC
303 // Perform the refresh on the UI thread\r
304 fRefreshPending = true;\r
305 fTable.getDisplay().asyncExec(new Runnable() {\r
306 public void run() {\r
307 fRefreshPending = false;\r
308 if (!fTable.isDisposed() && fTrace != null) {\r
309 fTable.setItemCount((int) fTrace.getNbEvents());\r
310 }\r
311 }\r
312 });\r
313 }\r
314 }\r
315 \r
316 @TmfSignalHandler\r
529ee6a9 317 public void currentTimeUpdated(final TmfTimeSynchSignal signal) {\r
db1ea19b 318 if (signal.getSource() != fTable && fTrace != null && !fTable.isDisposed()) {\r
529ee6a9
FC
319 Job job = new Job("seeking...") {\r
320 @Override\r
321 protected IStatus run(IProgressMonitor monitor) {\r
322 final int index = (int) fTrace.getRank(signal.getCurrentTime());\r
323 // Perform the updates on the UI thread\r
324 fTable.getDisplay().asyncExec(new Runnable() {\r
325 public void run() {\r
db1ea19b
FC
326 // Return if table is disposed\r
327 if (fTable.isDisposed()) return;\r
328 \r
529ee6a9
FC
329 fTable.setSelection(index);\r
330 // The timestamp might not correspond to an actual event\r
331 // and the selection will point to the next experiment event.\r
332 // But we would like to display both the event before and\r
333 // after the selected timestamp.\r
334 // This works fine by default except when the selected event\r
335 // is the top displayed event. The following ensures that we\r
336 // always see both events.\r
337 if ((index > 0) && (index == fTable.getTopIndex())) {\r
338 fTable.setTopIndex(index - 1);\r
339 }\r
340 }\r
341 });\r
342 return Status.OK_STATUS;\r
343 }};\r
344 job.schedule();\r
abfad0aa
FC
345 }\r
346 }\r
347}\r
This page took 0.043459 seconds and 5 git commands to generate.