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