1 /*******************************************************************************
2 * Copyright (c) 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 * Matthew Khouzam - Initial API and implementation
11 * Francois Chouinard - Refactoring, slider support, bug fixing
12 * Patrick Tasse - Improvements and bug fixing
13 * Xavier Raynaud - Improvements
14 ******************************************************************************/
16 package org
.eclipse
.linuxtools
.tmf
.ui
.widgets
;
18 import org
.eclipse
.swt
.SWT
;
19 import org
.eclipse
.swt
.custom
.TableEditor
;
20 import org
.eclipse
.swt
.events
.ControlAdapter
;
21 import org
.eclipse
.swt
.events
.ControlEvent
;
22 import org
.eclipse
.swt
.events
.KeyEvent
;
23 import org
.eclipse
.swt
.events
.KeyListener
;
24 import org
.eclipse
.swt
.events
.MouseEvent
;
25 import org
.eclipse
.swt
.events
.MouseListener
;
26 import org
.eclipse
.swt
.events
.MouseWheelListener
;
27 import org
.eclipse
.swt
.events
.SelectionAdapter
;
28 import org
.eclipse
.swt
.events
.SelectionEvent
;
29 import org
.eclipse
.swt
.events
.SelectionListener
;
30 import org
.eclipse
.swt
.graphics
.Point
;
31 import org
.eclipse
.swt
.graphics
.Rectangle
;
32 import org
.eclipse
.swt
.layout
.FillLayout
;
33 import org
.eclipse
.swt
.layout
.GridData
;
34 import org
.eclipse
.swt
.layout
.GridLayout
;
35 import org
.eclipse
.swt
.widgets
.Composite
;
36 import org
.eclipse
.swt
.widgets
.Control
;
37 import org
.eclipse
.swt
.widgets
.Display
;
38 import org
.eclipse
.swt
.widgets
.Event
;
39 import org
.eclipse
.swt
.widgets
.Label
;
40 import org
.eclipse
.swt
.widgets
.Listener
;
41 import org
.eclipse
.swt
.widgets
.Menu
;
42 import org
.eclipse
.swt
.widgets
.Shell
;
43 import org
.eclipse
.swt
.widgets
.Slider
;
44 import org
.eclipse
.swt
.widgets
.Table
;
45 import org
.eclipse
.swt
.widgets
.TableColumn
;
46 import org
.eclipse
.swt
.widgets
.TableItem
;
47 import org
.eclipse
.ui
.PlatformUI
;
50 * <b><u>TmfVirtualTable</u></b>
52 * TmfVirtualTable allows for the tabular display of arbitrarily large data sets
53 * (well, up to Integer.MAX_VALUE or ~2G rows).
55 * It is essentially a Composite of Table and Slider, where the number of rows
56 * in the table is set to fill the table display area. The slider is rank-based.
58 * It differs from Table with the VIRTUAL style flag where an empty entry is
59 * created for each virtual row. This does not scale well for very large data sets.
62 * H_SCROLL, V_SCROLL, SINGLE, CHECK, FULL_SELECTION, HIDE_SELECTION, NO_SCROLL
64 public class TmfVirtualTable
extends Composite
{
68 private int fTableRows
= 0; // Number of table rows
69 private int fFullyVisibleRows
= 0; // Number of fully visible table rows
70 private int fFrozenRowCount
= 0; // Number of frozen table rows at top of table
72 private int fTableTopEventRank
= 0; // Global rank of the first entry displayed
73 private int fSelectedEventRank
= 0; // Global rank of the selected event
74 private boolean fPendingSelection
= false; // Pending selection update
76 private int fTableItemCount
= 0;
79 private Slider fSlider
;
81 private int fLinuxItemHeight
= 0; // Calculated item height for Linux workaround
82 private TooltipProvider tooltipProvider
= null;
83 private IDoubleClickListener doubleClickListener
= null;
85 // ------------------------------------------------------------------------
87 // ------------------------------------------------------------------------
93 public TmfVirtualTable(Composite parent
, int style
) {
94 super(parent
, style
& (~SWT
.H_SCROLL
) & (~SWT
.V_SCROLL
) & (~SWT
.SINGLE
) & (~SWT
.FULL_SELECTION
) & (~SWT
.HIDE_SELECTION
) & (~SWT
.CHECK
));
96 // Create the controls
97 createTable(style
& (SWT
.H_SCROLL
| SWT
.SINGLE
| SWT
.FULL_SELECTION
| SWT
.HIDE_SELECTION
| SWT
.CHECK
));
98 createSlider(style
& SWT
.V_SCROLL
);
100 // Prevent the slider from being traversed
101 setTabList(new Control
[] { fTable
});
104 GridLayout gridLayout
= new GridLayout();
105 gridLayout
.numColumns
= 2;
106 gridLayout
.horizontalSpacing
= 0;
107 gridLayout
.verticalSpacing
= 0;
108 gridLayout
.marginWidth
= 0;
109 gridLayout
.marginHeight
= 0;
110 setLayout(gridLayout
);
112 GridData tableGridData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
113 fTable
.setLayoutData(tableGridData
);
115 GridData sliderGridData
= new GridData(SWT
.FILL
, SWT
.FILL
, false, true);
116 fSlider
.setLayoutData(sliderGridData
);
119 fTable
.addMouseWheelListener(new MouseWheelListener() {
121 public void mouseScrolled(MouseEvent event
) {
122 if (fTableItemCount
<= fFullyVisibleRows
) {
125 fTableTopEventRank
-= event
.count
;
126 if (fTableTopEventRank
< 0) {
127 fTableTopEventRank
= 0;
129 int latestFirstRowOffset
= fTableItemCount
- fFullyVisibleRows
;
130 if (fTableTopEventRank
> latestFirstRowOffset
) {
131 fTableTopEventRank
= latestFirstRowOffset
;
134 fSlider
.setSelection(fTableTopEventRank
);
139 fTable
.addListener(SWT
.MouseWheel
, new Listener() {
140 // disable mouse scroll of horizontal scroll bar
142 public void handleEvent(Event event
) {
147 fTable
.addControlListener(new ControlAdapter() {
149 public void controlResized(ControlEvent event
) {
150 int tableHeight
= Math
.max(0, fTable
.getClientArea().height
- fTable
.getHeaderHeight());
151 fFullyVisibleRows
= tableHeight
/ getItemHeight();
152 if (fTableItemCount
> 0) {
153 fSlider
.setThumb(Math
.max(1, Math
.min(fTableRows
, fFullyVisibleRows
)));
157 // Implement a "fake" tooltip
158 final String TOOLTIP_DATA_KEY
= "_TABLEITEM"; //$NON-NLS-1$
159 final Listener labelListener
= new Listener () {
160 public void handleEvent (Event event
) {
161 Label label
= (Label
)event
.widget
;
162 Shell shell
= label
.getShell ();
163 switch (event
.type
) {
165 Event e
= new Event ();
166 e
.item
= (TableItem
) label
.getData (TOOLTIP_DATA_KEY
);
167 // Assuming table is single select, set the selection as if
168 // the mouse down event went through to the table
169 fTable
.setSelection (new TableItem
[] {(TableItem
) e
.item
});
170 fTable
.notifyListeners (SWT
.Selection
, e
);
182 Listener tableListener
= new Listener () {
185 public void handleEvent (Event event
) {
186 switch (event
.type
) {
189 case SWT
.MouseMove
: {
190 if (tip
== null) break;
196 case SWT
.MouseHover
: {
197 TableItem item
= fTable
.getItem (new Point(event
.x
, event
.y
));
199 for(int i
=0;i
<fTable
.getColumnCount();i
++){
200 Rectangle bounds
= item
.getBounds(i
);
201 if (bounds
.contains(event
.x
,event
.y
)){
202 if (tip
!= null && !tip
.isDisposed()) tip
.dispose();
203 if (tooltipProvider
== null) {
206 String tooltipText
= tooltipProvider
.getTooltip(i
, item
.getData());
207 if (tooltipText
== null) return;
208 tip
= new Shell(fTable
.getShell(), SWT
.ON_TOP
| SWT
.NO_FOCUS
| SWT
.TOOL
);
209 tip
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
210 FillLayout layout
= new FillLayout();
211 layout
.marginWidth
= 2;
212 tip
.setLayout(layout
);
213 label
= new Label(tip
, SWT
.WRAP
);
214 label
.setForeground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_FOREGROUND
));
215 label
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
216 label
.setData(TOOLTIP_DATA_KEY
, item
);
217 label
.setText(tooltipText
);
219 label
.addListener(SWT
.MouseExit
, labelListener
);
220 label
.addListener(SWT
.MouseDown
, labelListener
);
221 label
.addListener(SWT
.MouseWheel
, labelListener
);
222 Point size
= tip
.computeSize(SWT
.DEFAULT
, SWT
.DEFAULT
);
223 Point pt
= fTable
.toDisplay(bounds
.x
, bounds
.y
);
224 tip
.setBounds(pt
.x
, pt
.y
, size
.x
, size
.y
);
225 tip
.setVisible(true);
235 fTable
.addListener(SWT
.Dispose
, tableListener
);
236 fTable
.addListener(SWT
.KeyDown
, tableListener
);
237 fTable
.addListener(SWT
.MouseMove
, tableListener
);
238 fTable
.addListener(SWT
.MouseHover
, tableListener
);
239 addControlListener(new ControlAdapter() {
241 public void controlResized(ControlEvent event
) {
250 // ------------------------------------------------------------------------
252 // ------------------------------------------------------------------------
255 * Create the table and add listeners
257 private void createTable(int style
) {
258 fTable
= new Table(this, style
| SWT
.NO_SCROLL
);
260 fTable
.addSelectionListener(new SelectionAdapter() {
262 public void widgetSelected(SelectionEvent event
) {
263 if (fTable
.getSelectionIndices().length
> 0) {
264 handleTableSelection();
269 fTable
.addKeyListener(new KeyListener() {
271 public void keyPressed(KeyEvent event
) {
272 handleTableKeyEvent(event
);
275 public void keyReleased(KeyEvent event
) {
280 SWT
.MouseDoubleClick
, new Listener() {
282 public void handleEvent(Event event
) {
283 if (doubleClickListener
!= null) {
284 TableItem item
= fTable
.getItem (new Point (event
.x
, event
.y
));
286 for(int i
=0;i
<fTable
.getColumnCount();i
++){
287 Rectangle bounds
= item
.getBounds(i
);
288 if (bounds
.contains(event
.x
,event
.y
)){
289 doubleClickListener
.handleDoubleClick(TmfVirtualTable
.this, item
, i
);
301 * Update the rows and selected item
303 private void handleTableSelection() {
304 int selectedRow
= fTable
.getSelectionIndices()[0];
305 if (selectedRow
< fFrozenRowCount
) {
306 fSelectedEventRank
= selectedRow
;
308 fSelectedEventRank
= fTableTopEventRank
+ selectedRow
;
312 * Feature in Windows. When a partially visible table item is selected,
313 * after ~500 ms the top index is changed to ensure the selected item is
314 * fully visible. This leaves a blank space at the bottom of the virtual
315 * table. The workaround is to update the top event rank, refresh the
316 * table and reset the top index to 0 after a sufficient delay.
318 if (selectedRow
>= fFullyVisibleRows
) {
319 final Display display
= fTable
.getDisplay();
320 Thread thread
= new Thread("Top index check") { //$NON-NLS-1$
325 } catch (InterruptedException e
) {
328 display
.asyncExec(new Runnable() {
331 if (fTable
.isDisposed()) return;
332 int topIndex
= fTable
.getTopIndex();
334 fTableTopEventRank
+= topIndex
;
336 fSlider
.setSelection(fTableTopEventRank
);
337 fTable
.setTopIndex(0);
348 * Handle key-based navigation in table.
352 private void handleTableKeyEvent(KeyEvent event
) {
354 int lastEventRank
= fTableItemCount
- 1;
355 int lastPageTopEntryRank
= Math
.max(0, fTableItemCount
- fFullyVisibleRows
);
357 int previousSelectedEventRank
= fSelectedEventRank
;
358 int selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
359 boolean needsRefresh
= false;
361 // In all case, perform the following steps:
362 // - Update the selected entry rank (within valid range)
363 // - Update the selected row
364 // - Update the page's top entry if necessary (which also adjusts the selected row)
365 // - If the top displayed entry was changed, table refresh is needed
366 switch (event
.keyCode
) {
368 case SWT
.ARROW_DOWN
: {
370 if (fSelectedEventRank
< lastEventRank
) {
371 fSelectedEventRank
++;
372 selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
373 if (selectedRow
>= fFullyVisibleRows
) {
374 fTableTopEventRank
++;
383 if (fSelectedEventRank
> 0) {
384 fSelectedEventRank
--;
385 selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
386 if (selectedRow
< fFrozenRowCount
&& fTableTopEventRank
> 0) {
387 fTableTopEventRank
--;
396 fTableTopEventRank
= lastPageTopEntryRank
;
397 fSelectedEventRank
= lastEventRank
;
404 fSelectedEventRank
= fFrozenRowCount
;
405 fTableTopEventRank
= 0;
410 case SWT
.PAGE_DOWN
: {
412 if (fSelectedEventRank
< lastEventRank
) {
413 fSelectedEventRank
+= fFullyVisibleRows
;
414 if (fSelectedEventRank
> lastEventRank
) {
415 fSelectedEventRank
= lastEventRank
;
417 selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
418 if (selectedRow
> fFullyVisibleRows
- 1) {
419 fTableTopEventRank
+= fFullyVisibleRows
;
420 if (fTableTopEventRank
> lastPageTopEntryRank
) {
421 fTableTopEventRank
= lastPageTopEntryRank
;
431 if (fSelectedEventRank
> 0) {
432 fSelectedEventRank
-= fFullyVisibleRows
;
433 if (fSelectedEventRank
< fFrozenRowCount
) {
434 fSelectedEventRank
= fFrozenRowCount
;
436 selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
437 if (selectedRow
< 0) {
438 fTableTopEventRank
-= fFullyVisibleRows
;
439 if (fTableTopEventRank
< 0) {
440 fTableTopEventRank
= 0;
454 done
= refreshTable(); // false if table items not updated yet in this thread
456 fTable
.select(selectedRow
);
459 if (fFullyVisibleRows
< fTableItemCount
) {
460 fSlider
.setSelection(fTableTopEventRank
);
463 if (fSelectedEventRank
!= previousSelectedEventRank
&& fTable
.getSelection().length
> 0) {
465 Event e
= new Event();
466 e
.item
= fTable
.getSelection()[0];
467 fTable
.notifyListeners(SWT
.Selection
, e
);
469 fPendingSelection
= true;
474 private boolean setDataItem(int index
, TableItem item
) {
476 Event event
= new Event();
478 if (index
< fFrozenRowCount
) {
481 event
.index
= index
+ fTableTopEventRank
;
484 fTable
.notifyListeners(SWT
.SetData
, event
);
485 return event
.doit
; // false if table item not updated yet in this thread
490 // ------------------------------------------------------------------------
492 // ------------------------------------------------------------------------
494 private void createSlider(int style
) {
495 fSlider
= new Slider(this, SWT
.VERTICAL
| SWT
.NO_FOCUS
);
496 fSlider
.setMinimum(0);
497 fSlider
.setMaximum(0);
498 if ((style
& SWT
.V_SCROLL
) == 0) {
499 fSlider
.setVisible(false);
502 fSlider
.addListener(SWT
.Selection
, new Listener() {
504 public void handleEvent(Event event
) {
505 switch (event
.detail
) {
513 fTableTopEventRank
= fSlider
.getSelection();
522 // ------------------------------------------------------------------------
523 // Simulated Table API
524 // ------------------------------------------------------------------------
526 public void setHeaderVisible(boolean b
) {
527 fTable
.setHeaderVisible(b
);
530 public void setLinesVisible(boolean b
) {
531 fTable
.setLinesVisible(b
);
534 public TableItem
[] getSelection() {
535 return fTable
.getSelection();
539 public void addListener(int eventType
, Listener listener
) {
540 fTable
.addListener(eventType
, listener
);
544 public void addKeyListener(KeyListener listener
) {
545 fTable
.addKeyListener(listener
);
550 public void addMouseListener(MouseListener listener
) {
551 fTable
.addMouseListener(listener
);
554 public void addSelectionListener(SelectionListener listener
) {
555 fTable
.addSelectionListener(listener
);
559 public void setMenu(Menu menu
) {
560 fTable
.setMenu(menu
);
563 public void clearAll() {
567 public void setItemCount(int nbItems
) {
568 nbItems
= Math
.max(0, nbItems
);
570 if (nbItems
!= fTableItemCount
) {
571 fTableItemCount
= nbItems
;
572 fTable
.remove(fTableItemCount
, fTable
.getItemCount() - 1);
573 fSlider
.setMaximum(nbItems
);
575 int tableHeight
= Math
.max(0, fTable
.getClientArea().height
- fTable
.getHeaderHeight());
576 fFullyVisibleRows
= tableHeight
/ getItemHeight();
577 if (fTableItemCount
> 0) {
578 fSlider
.setThumb(Math
.max(1, Math
.min(fTableRows
, fFullyVisibleRows
)));
583 public int getItemCount() {
584 return fTableItemCount
;
587 public int getItemHeight() {
589 * Bug in Linux. The method getItemHeight doesn't always return the correct value.
591 if (fLinuxItemHeight
>= 0 && System
.getProperty("os.name").contains("Linux")) { //$NON-NLS-1$ //$NON-NLS-2$
592 if (fLinuxItemHeight
!= 0) {
593 return fLinuxItemHeight
;
595 if (fTable
.getItemCount() > 1) {
596 int itemHeight
= fTable
.getItem(1).getBounds().y
- fTable
.getItem(0).getBounds().y
;
597 if (itemHeight
> 0) {
598 fLinuxItemHeight
= itemHeight
;
599 return fLinuxItemHeight
;
603 fLinuxItemHeight
= -1; // Not Linux, don't perform os.name check anymore
605 return fTable
.getItemHeight();
608 public int getTopIndex() {
609 return fTableTopEventRank
+ fFrozenRowCount
;
612 public void setTopIndex(int i
) {
613 if (fTableItemCount
> 0) {
614 i
= Math
.min(i
, fTableItemCount
- 1);
615 i
= Math
.max(i
, fFrozenRowCount
);
617 fTableTopEventRank
= i
- fFrozenRowCount
;
618 if (fFullyVisibleRows
< fTableItemCount
) {
619 fSlider
.setSelection(fTableTopEventRank
);
626 public int indexOf(TableItem ti
) {
627 int index
= fTable
.indexOf(ti
);
628 if (index
< fFrozenRowCount
) {
631 return (index
- fFrozenRowCount
) + getTopIndex();
635 public TableColumn
[] getColumns() {
636 return fTable
.getColumns();
639 public TableItem
getItem(Point point
) {
640 return fTable
.getItem(point
);
643 private void resize() {
644 // Compute the numbers of rows that fit the new area
645 int tableHeight
= Math
.max(0, getSize().y
- fTable
.getHeaderHeight());
646 int itemHeight
= getItemHeight();
647 fTableRows
= Math
.min((tableHeight
+ itemHeight
- 1) / itemHeight
, fTableItemCount
);
649 if (fTableTopEventRank
+ fFullyVisibleRows
> fTableItemCount
) {
650 // If we are at the end, get elements before to populate
651 fTableTopEventRank
= Math
.max(0, fTableItemCount
- fFullyVisibleRows
);
653 } else if (fTableRows
> fTable
.getItemCount() || fTableItemCount
< fTable
.getItemCount()) {
654 // Only refresh if new table items are needed or if table items need to be deleted
660 // ------------------------------------------------------------------------
661 // Controls interactions
662 // ------------------------------------------------------------------------
665 public boolean setFocus() {
666 boolean isVisible
= isVisible();
673 public void refresh() {
674 boolean done
= refreshTable();
675 if (fPendingSelection
&& done
) {
676 fPendingSelection
= false;
677 if (fTable
.getSelection().length
> 0) {
678 Event e
= new Event();
679 e
.item
= fTable
.getSelection()[0];
680 fTable
.notifyListeners(SWT
.Selection
, e
);
685 public void setColumnHeaders(ColumnData columnData
[]) {
686 for (int i
= 0; i
< columnData
.length
; i
++) {
687 TableColumn column
= new TableColumn(fTable
, columnData
[i
].alignment
, i
);
688 column
.setText(columnData
[i
].header
);
689 if (columnData
[i
].width
> 0) {
690 column
.setWidth(columnData
[i
].width
);
697 public int removeAll() {
699 fSlider
.setMaximum(0);
701 fSelectedEventRank
= fFrozenRowCount
;
705 private boolean refreshTable() {
707 for (int i
= 0; i
< fTableRows
; i
++) {
708 if (i
+ fTableTopEventRank
< fTableItemCount
) {
710 if (i
< fTable
.getItemCount()) {
711 tableItem
= fTable
.getItem(i
);
713 tableItem
= new TableItem(fTable
, SWT
.NONE
);
715 done
&= setDataItem(i
, tableItem
); // false if table item not updated yet in this thread
717 if (fTable
.getItemCount() > fTableItemCount
- fTableTopEventRank
) {
718 fTable
.remove(fTableItemCount
- fTableTopEventRank
);
723 int lastRowOffset
= fTableTopEventRank
+ fTableRows
- 1;
724 if ((fSelectedEventRank
>= fTableTopEventRank
+ fFrozenRowCount
) && (fSelectedEventRank
<= lastRowOffset
)) {
725 int selectedRow
= fSelectedEventRank
- fTableTopEventRank
;
726 fTable
.select(selectedRow
);
727 } else if (fSelectedEventRank
< fFrozenRowCount
) {
728 fTable
.select(fSelectedEventRank
);
730 fTable
.deselectAll();
735 public void setSelection(int i
) {
736 if (fTableItemCount
> 0) {
737 i
= Math
.min(i
, fTableItemCount
- 1);
740 fSelectedEventRank
= i
;
741 if ((i
< fTableTopEventRank
+ fFrozenRowCount
&& i
>= fFrozenRowCount
) ||
742 (i
>= fTableTopEventRank
+ fFullyVisibleRows
)) {
743 fTableTopEventRank
= Math
.max(0, i
- fFrozenRowCount
- fFullyVisibleRows
/ 2);
745 if (fFullyVisibleRows
< fTableItemCount
) {
746 fSlider
.setSelection(fTableTopEventRank
);
754 public int getSelectionIndex() {
755 int index
= fTable
.getSelectionIndex();
757 return fSelectedEventRank
;
759 if (index
< fFrozenRowCount
) {
762 return (index
- fFrozenRowCount
) + getTopIndex();
766 public void setFrozenRowCount(int count
) {
767 fFrozenRowCount
= count
;
771 public TableEditor
createTableEditor() {
772 return new TableEditor(fTable
);
775 public Control
createTableEditorControl(Class
<?
extends Control
> control
) {
777 return (Control
) control
.getConstructor(Composite
.class, int.class).newInstance(new Object
[] {fTable
, SWT
.NONE
});
778 } catch (Exception e
) {
785 * @return the tooltipProvider
787 public TooltipProvider
getTooltipProvider() {
788 return tooltipProvider
;
792 * @param tooltipProvider the tooltipProvider to set
794 public void setTooltipProvider(TooltipProvider tooltipProvider
) {
795 this.tooltipProvider
= tooltipProvider
;
799 * @return the doubleClickListener
801 public IDoubleClickListener
getDoubleClickListener() {
802 return doubleClickListener
;
806 * @param doubleClickListener the doubleClickListener to set
808 public void setDoubleClickListener(IDoubleClickListener doubleClickListener
) {
809 this.doubleClickListener
= doubleClickListener
;