1 /*******************************************************************************
2 * Copyright (c) 2009, 2010 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.ui
.views
;
15 import org
.eclipse
.linuxtools
.tmf
.event
.TmfEvent
;
16 import org
.eclipse
.linuxtools
.tmf
.event
.TmfTimestamp
;
17 import org
.eclipse
.linuxtools
.tmf
.experiment
.TmfExperiment
;
18 import org
.eclipse
.linuxtools
.tmf
.experiment
.TmfExperimentSelectedSignal
;
19 import org
.eclipse
.linuxtools
.tmf
.experiment
.TmfExperimentUpdatedSignal
;
20 import org
.eclipse
.linuxtools
.tmf
.request
.TmfDataRequest
;
21 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfSignalHandler
;
22 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfTimeSynchSignal
;
23 import org
.eclipse
.swt
.SWT
;
24 import org
.eclipse
.swt
.events
.SelectionAdapter
;
25 import org
.eclipse
.swt
.events
.SelectionEvent
;
26 import org
.eclipse
.swt
.layout
.GridData
;
27 import org
.eclipse
.swt
.widgets
.Composite
;
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
.TableColumn
;
32 import org
.eclipse
.swt
.widgets
.TableItem
;
35 * <b><u>TmfEventsView</u></b>
38 * TODO: Implement me. Please.
39 * TODO: Handle column selection, sort, ... generically (nothing less...)
40 * TODO: Implement hide/display columns
42 public class TmfEventsView
extends TmfView
{
44 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.views.events";
46 private TmfExperiment
<TmfEvent
> fExperiment
;
47 private String fTitlePrefix
;
49 // ------------------------------------------------------------------------
51 // ------------------------------------------------------------------------
56 private final String TIMESTAMP_COLUMN
= "Timestamp";
57 private final String SOURCE_COLUMN
= "Source";
58 private final String TYPE_COLUMN
= "Type";
59 private final String REFERENCE_COLUMN
= "File";
60 private final String CONTENT_COLUMN
= "Content";
61 private final String
[] columnProperties
= new String
[] {
70 private class ColumnData
{
71 public final String header
;
72 public final int width
;
73 public final int alignment
;
75 public ColumnData(String h
, int w
, int a
) {
82 private ColumnData
[] columnData
= new ColumnData
[] {
83 new ColumnData(columnProperties
[0], 100, SWT
.LEFT
),
84 new ColumnData(columnProperties
[1], 100, SWT
.LEFT
),
85 new ColumnData(columnProperties
[2], 100, SWT
.LEFT
),
86 new ColumnData(columnProperties
[3], 100, SWT
.LEFT
),
87 new ColumnData(columnProperties
[4], 100, SWT
.LEFT
)
90 // ------------------------------------------------------------------------
92 // ------------------------------------------------------------------------
94 private static final int DEFAULT_CACHE_SIZE
= 1000;
95 private final int fCacheSize
;
96 private TmfEvent
[] cache
= new TmfEvent
[1];
97 private int cacheStartIndex
= 0;
98 private int cacheEndIndex
= 0;
100 // ------------------------------------------------------------------------
102 // ------------------------------------------------------------------------
104 public TmfEventsView(int cacheSize
) {
106 fCacheSize
= cacheSize
;
109 public TmfEventsView() {
110 this(DEFAULT_CACHE_SIZE
);
113 // ------------------------------------------------------------------------
115 // ------------------------------------------------------------------------
117 @SuppressWarnings("unchecked")
119 public void createPartControl(Composite parent
) {
121 // Create a virtual table
122 // TODO: change SINGLE to MULTI line selection and adjust the selection listener
123 final int style
= SWT
.SINGLE
| SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.BORDER
| SWT
.VIRTUAL
;
124 fTable
= new Table(parent
, style
);
126 // Set the table layout
127 GridData layoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
128 fTable
.setLayoutData(layoutData
);
130 // Some cosmetic enhancements
131 fTable
.setHeaderVisible(true);
132 fTable
.setLinesVisible(true);
135 createColumnHeaders(fTable
);
137 // Handle the table item requests
138 fTable
.addSelectionListener(new SelectionAdapter() {
141 public void widgetSelected(SelectionEvent e
) {
142 TmfTimestamp ts
= (TmfTimestamp
) fTable
.getSelection()[0].getData();
143 broadcast(new TmfTimeSynchSignal(fTable
, ts
));
147 // Handle the table item requests
148 fTable
.addListener(SWT
.SetData
, new Listener() {
150 public void handleEvent(Event event
) {
152 TableItem item
= (TableItem
) event
.item
;
153 final int index
= fTable
.indexOf(item
);
155 // Note: this works because handleEvent() is called once for each row, in sequence
156 if ((index
>= cacheStartIndex
) && (index
< cacheEndIndex
)) {
157 int i
= index
- cacheStartIndex
;
158 item
.setText(extractItemFields(cache
[i
]));
159 item
.setData(new TmfTimestamp(cache
[i
].getTimestamp()));
163 TmfDataRequest
<TmfEvent
> request
= new TmfDataRequest
<TmfEvent
>(TmfEvent
.class, index
, fCacheSize
) {
165 public void handleData() {
166 TmfEvent
[] tmpEvent
= getData();
167 if ( (tmpEvent
!= null) && (tmpEvent
.length
> 0) ) {
169 cacheStartIndex
= index
;
170 cacheEndIndex
= index
+ cache
.length
;
174 fExperiment
.processRequest(request
, true);
176 if (cache
[0] != null && cacheStartIndex
== index
) {
177 item
.setText(extractItemFields(cache
[0]));
178 item
.setData(new TmfTimestamp(cache
[0].getTimestamp()));
184 fTable
.setItemCount(0);
185 fTitlePrefix
= getTitle();
187 // If an experiment is already selected, update the table
188 fExperiment
= (TmfExperiment
<TmfEvent
>) TmfExperiment
.getCurrentExperiment();
189 if (fExperiment
!= null) {
190 experimentSelected(new TmfExperimentSelectedSignal(fTable
, fExperiment
));
197 * FIXME: Add support for column selection
199 protected void createColumnHeaders(Table table
) {
200 for (int i
= 0; i
< columnData
.length
; i
++) {
201 TableColumn column
= new TableColumn(table
, columnData
[i
].alignment
, i
);
202 column
.setText(columnData
[i
].header
);
203 column
.setWidth(columnData
[i
].width
);
211 * FIXME: Add support for column selection
213 protected String
[] extractItemFields(TmfEvent event
) {
214 String
[] fields
= new String
[0];
216 fields
= new String
[] {
217 new Long(event
.getTimestamp().getValue()).toString(),
218 event
.getSource().getSourceId().toString(),
219 event
.getType().getTypeId().toString(),
220 event
.getReference().getReference().toString(),
221 event
.getContent().toString()
228 * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
231 public void setFocus() {
235 * @see java.lang.Object#toString()
238 public String
toString() {
239 return "[TmfEventsView]";
242 // ------------------------------------------------------------------------
244 // ------------------------------------------------------------------------
246 @SuppressWarnings("unchecked")
248 public void experimentSelected(TmfExperimentSelectedSignal signal
) {
249 // Update the trace reference
250 fExperiment
= (TmfExperiment
<TmfEvent
>) signal
.getExperiment();
251 setPartName(fTitlePrefix
+ " - " + fExperiment
.getName());
253 // Perform the updates on the UI thread
254 fTable
.getDisplay().asyncExec(new Runnable() {
256 // // TODO: Potentially long operation. Add some feedback for the user
257 fTable
.setSelection(0);
259 cacheStartIndex
= cacheEndIndex
= 0; // Clear the cache
260 fTable
.setItemCount((int) fExperiment
.getNbEvents());
266 public void experimentUpdated(TmfExperimentUpdatedSignal signal
) {
267 // Perform the refresh on the UI thread
268 fTable
.getDisplay().asyncExec(new Runnable() {
270 if (!fTable
.isDisposed() && fExperiment
!= null) {
271 fTable
.setItemCount((int) fExperiment
.getNbEvents());
278 public void currentTimeUpdated(TmfTimeSynchSignal signal
) {
279 if (signal
.getSource() != fTable
&& fExperiment
!= null) {
280 final int index
= (int) fExperiment
.getRank(signal
.getCurrentTime());
281 // Perform the updates on the UI thread
282 fTable
.getDisplay().asyncExec(new Runnable() {
284 fTable
.setSelection(index
);
285 // The timestamp might not correspond to an actual event
286 // and the selection will point to the next experiment event.
287 // But we would like to display both the event before and
288 // after the selected timestamp.
289 // This works fine by default except when the selected event
290 // is the top displayed event. The following ensures that we
291 // always see both events.
292 if ((index
> 0) && (index
== fTable
.getTopIndex())) {
293 fTable
.setTopIndex(index
- 1);