1 /*******************************************************************************
2 * Copyright (c) 2012 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 * Patrick Tasse - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
;
15 import java
.util
.ArrayList
;
16 import java
.util
.Arrays
;
17 import java
.util
.HashMap
;
19 import org
.eclipse
.jface
.viewers
.ILabelProviderListener
;
20 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
21 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
22 import org
.eclipse
.jface
.viewers
.ITableLabelProvider
;
23 import org
.eclipse
.jface
.viewers
.ITreeContentProvider
;
24 import org
.eclipse
.jface
.viewers
.ITreeViewerListener
;
25 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
26 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
27 import org
.eclipse
.jface
.viewers
.TreeExpansionEvent
;
28 import org
.eclipse
.jface
.viewers
.TreeViewer
;
29 import org
.eclipse
.jface
.viewers
.Viewer
;
30 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.ITimeGraphEntry
;
31 import org
.eclipse
.swt
.SWT
;
32 import org
.eclipse
.swt
.custom
.SashForm
;
33 import org
.eclipse
.swt
.events
.ControlAdapter
;
34 import org
.eclipse
.swt
.events
.ControlEvent
;
35 import org
.eclipse
.swt
.events
.MouseEvent
;
36 import org
.eclipse
.swt
.events
.MouseWheelListener
;
37 import org
.eclipse
.swt
.events
.PaintEvent
;
38 import org
.eclipse
.swt
.events
.PaintListener
;
39 import org
.eclipse
.swt
.events
.SelectionAdapter
;
40 import org
.eclipse
.swt
.events
.SelectionEvent
;
41 import org
.eclipse
.swt
.graphics
.Image
;
42 import org
.eclipse
.swt
.graphics
.Point
;
43 import org
.eclipse
.swt
.layout
.FillLayout
;
44 import org
.eclipse
.swt
.widgets
.Composite
;
45 import org
.eclipse
.swt
.widgets
.Display
;
46 import org
.eclipse
.swt
.widgets
.Event
;
47 import org
.eclipse
.swt
.widgets
.Listener
;
48 import org
.eclipse
.swt
.widgets
.Slider
;
49 import org
.eclipse
.swt
.widgets
.Tree
;
50 import org
.eclipse
.swt
.widgets
.TreeColumn
;
51 import org
.eclipse
.swt
.widgets
.TreeItem
;
53 public class TimeGraphCombo
extends Composite
{
55 // ------------------------------------------------------------------------
57 // ------------------------------------------------------------------------
59 private static final Object FILLER
= new Object();
61 // ------------------------------------------------------------------------
63 // ------------------------------------------------------------------------
66 private TreeViewer fTreeViewer
;
69 private TimeGraphViewer fTimeGraphViewer
;
71 // The selection listener map
72 private HashMap
<ITimeGraphSelectionListener
, SelectionListenerWrapper
> fSelectionListenerMap
= new HashMap
<ITimeGraphSelectionListener
, SelectionListenerWrapper
>();
74 // Flag to block the tree selection changed listener when triggered by the time graph combo
75 private boolean fInhibitTreeSelection
= false;
77 // Number of filler rows used by the tree content provider
78 private static int fNumFillerRows
;
80 // Calculated item height for Linux workaround
81 private int fLinuxItemHeight
= 0;
83 // ------------------------------------------------------------------------
85 // ------------------------------------------------------------------------
87 private class TreeContentProviderWrapper
implements ITreeContentProvider
{
88 private ITreeContentProvider contentProvider
;
90 public TreeContentProviderWrapper(ITreeContentProvider contentProvider
) {
91 this.contentProvider
= contentProvider
;
95 public void dispose() {
96 contentProvider
.dispose();
100 public void inputChanged(Viewer viewer
, Object oldInput
, Object newInput
) {
101 contentProvider
.inputChanged(viewer
, oldInput
, newInput
);
105 public Object
[] getElements(Object inputElement
) {
106 Object
[] elements
= contentProvider
.getElements(inputElement
);
107 // add filler elements to ensure alignment with time analysis viewer
108 Object
[] oElements
= Arrays
.copyOf(elements
, elements
.length
+ fNumFillerRows
, new Object
[0].getClass());
109 for (int i
= 0; i
< fNumFillerRows
; i
++) {
110 oElements
[elements
.length
+ i
] = FILLER
;
116 public Object
[] getChildren(Object parentElement
) {
117 if (parentElement
instanceof ITimeGraphEntry
) {
118 return contentProvider
.getChildren(parentElement
);
120 return new Object
[0];
125 public Object
getParent(Object element
) {
126 if (element
instanceof ITimeGraphEntry
) {
127 return contentProvider
.getParent(element
);
134 public boolean hasChildren(Object element
) {
135 if (element
instanceof ITimeGraphEntry
) {
136 return contentProvider
.hasChildren(element
);
143 private class TreeLabelProviderWrapper
implements ITableLabelProvider
{
144 private ITableLabelProvider labelProvider
;
146 public TreeLabelProviderWrapper(ITableLabelProvider labelProvider
) {
147 this.labelProvider
= labelProvider
;
151 public void addListener(ILabelProviderListener listener
) {
152 labelProvider
.addListener(listener
);
156 public void dispose() {
157 labelProvider
.dispose();
161 public boolean isLabelProperty(Object element
, String property
) {
162 if (element
instanceof ITimeGraphEntry
) {
163 return labelProvider
.isLabelProperty(element
, property
);
170 public void removeListener(ILabelProviderListener listener
) {
171 labelProvider
.removeListener(listener
);
175 public Image
getColumnImage(Object element
, int columnIndex
) {
176 if (element
instanceof ITimeGraphEntry
) {
177 return labelProvider
.getColumnImage(element
, columnIndex
);
184 public String
getColumnText(Object element
, int columnIndex
) {
185 if (element
instanceof ITimeGraphEntry
) {
186 return labelProvider
.getColumnText(element
, columnIndex
);
194 private class SelectionListenerWrapper
implements ISelectionChangedListener
, ITimeGraphSelectionListener
{
195 private ITimeGraphSelectionListener listener
;
196 private ITimeGraphEntry selection
= null;
198 public SelectionListenerWrapper(ITimeGraphSelectionListener listener
) {
199 this.listener
= listener
;
203 public void selectionChanged(SelectionChangedEvent event
) {
204 if (fInhibitTreeSelection
) {
207 Object element
= ((IStructuredSelection
) event
.getSelection()).getFirstElement();
208 if (element
instanceof ITimeGraphEntry
) {
209 ITimeGraphEntry entry
= (ITimeGraphEntry
) element
;
210 if (entry
!= selection
) {
212 listener
.selectionChanged(new TimeGraphSelectionEvent(event
.getSource(), selection
));
218 public void selectionChanged(TimeGraphSelectionEvent event
) {
219 ITimeGraphEntry entry
= event
.getSelection();
220 if (entry
!= selection
) {
222 listener
.selectionChanged(new TimeGraphSelectionEvent(event
.getSource(), selection
));
227 // ------------------------------------------------------------------------
229 // ------------------------------------------------------------------------
231 public TimeGraphCombo(Composite parent
, int style
) {
232 super(parent
, style
);
233 setLayout(new FillLayout());
235 final SashForm sash
= new SashForm(this, SWT
.NONE
);
237 fTreeViewer
= new TreeViewer(sash
, SWT
.FULL_SELECTION
| SWT
.H_SCROLL
);
238 final Tree tree
= fTreeViewer
.getTree();
239 tree
.setHeaderVisible(true);
240 tree
.setLinesVisible(true);
242 fTimeGraphViewer
= new TimeGraphViewer(sash
, SWT
.NONE
);
243 fTimeGraphViewer
.setItemHeight(getItemHeight(tree
));
244 fTimeGraphViewer
.setHeaderHeight(tree
.getHeaderHeight());
245 fTimeGraphViewer
.setBorderWidth(tree
.getBorderWidth());
246 fTimeGraphViewer
.setNameWidthPref(0);
248 // Bug in Linux. The tree header height is 0 in constructor,
249 // so we need to reset it later when the control is resized.
250 tree
.addControlListener(new ControlAdapter() {
252 public void controlResized(ControlEvent e
) {
253 fTreeViewer
.getTree().getVerticalBar().setEnabled(false);
254 fTreeViewer
.getTree().getVerticalBar().setVisible(false);
255 fTimeGraphViewer
.setHeaderHeight(tree
.getHeaderHeight());
259 fTreeViewer
.addTreeListener(new ITreeViewerListener() {
261 public void treeCollapsed(TreeExpansionEvent event
) {
262 fTimeGraphViewer
.setExpandedState((ITimeGraphEntry
) event
.getElement(), false);
266 public void treeExpanded(TreeExpansionEvent event
) {
267 fTimeGraphViewer
.setExpandedState((ITimeGraphEntry
) event
.getElement(), true);
271 fTimeGraphViewer
.addTreeListener(new ITimeGraphTreeListener() {
273 public void treeCollapsed(TimeGraphTreeExpansionEvent event
) {
274 fTreeViewer
.setExpandedState(event
.getEntry(), false);
278 public void treeExpanded(TimeGraphTreeExpansionEvent event
) {
279 fTreeViewer
.setExpandedState(event
.getEntry(), true);
283 // prevent mouse button from selecting a filler tree item
284 tree
.addListener(SWT
.MouseDown
, new Listener() {
286 public void handleEvent(Event event
) {
287 TreeItem treeItem
= tree
.getItem(new Point(event
.x
, event
.y
));
288 if (treeItem
== null || treeItem
.getData() == FILLER
) {
290 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
291 if (treeItems
.size() == 0) {
292 fTreeViewer
.setSelection(new StructuredSelection());
293 fTimeGraphViewer
.setSelection(null);
296 // this prevents from scrolling up when selecting
297 // the partially visible tree item at the bottom
298 tree
.select(treeItems
.get(treeItems
.size() - 1));
299 fTreeViewer
.setSelection(new StructuredSelection());
300 fTimeGraphViewer
.setSelection(null);
305 tree
.addListener(SWT
.MouseWheel
, new Listener() {
307 public void handleEvent(Event event
) {
309 Slider scrollBar
= fTimeGraphViewer
.getVerticalBar();
310 fTimeGraphViewer
.setTopIndex(scrollBar
.getSelection() - event
.count
);
311 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
312 if (treeItems
.size() == 0) {
315 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
316 tree
.setTopItem(treeItem
);
320 // prevent key stroke from selecting a filler tree item
321 tree
.addListener(SWT
.KeyDown
, new Listener() {
323 public void handleEvent(Event event
) {
324 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
325 if (treeItems
.size() == 0) {
326 fTreeViewer
.setSelection(new StructuredSelection());
330 if (event
.keyCode
== SWT
.ARROW_DOWN
) {
331 int index
= Math
.min(fTimeGraphViewer
.getSelectionIndex() + 1, treeItems
.size() - 1);
332 fTimeGraphViewer
.setSelection((ITimeGraphEntry
) treeItems
.get(index
).getData());
334 } else if (event
.keyCode
== SWT
.PAGE_DOWN
) {
335 int height
= tree
.getSize().y
- tree
.getHeaderHeight() - tree
.getHorizontalBar().getSize().y
;
336 int countPerPage
= height
/ getItemHeight(tree
);
337 int index
= Math
.min(fTimeGraphViewer
.getSelectionIndex() + countPerPage
- 1, treeItems
.size() - 1);
338 fTimeGraphViewer
.setSelection((ITimeGraphEntry
) treeItems
.get(index
).getData());
340 } else if (event
.keyCode
== SWT
.END
) {
341 fTimeGraphViewer
.setSelection((ITimeGraphEntry
) treeItems
.get(treeItems
.size() - 1).getData());
344 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
345 tree
.setTopItem(treeItem
);
346 if (fTimeGraphViewer
.getSelectionIndex() >= 0) {
347 fTreeViewer
.setSelection(new StructuredSelection(fTimeGraphViewer
.getSelection()));
349 fTreeViewer
.setSelection(new StructuredSelection());
354 fTimeGraphViewer
.getTimeGraphControl().addControlListener(new ControlAdapter() {
356 public void controlResized(ControlEvent e
) {
357 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
358 if (treeItems
.size() == 0) {
361 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
362 tree
.setTopItem(treeItem
);
366 fTreeViewer
.addSelectionChangedListener(new ISelectionChangedListener() {
368 public void selectionChanged(SelectionChangedEvent event
) {
369 if (fInhibitTreeSelection
) {
372 if (event
.getSelection() instanceof IStructuredSelection
) {
373 Object selection
= ((IStructuredSelection
) event
.getSelection()).getFirstElement();
374 if (selection
instanceof ITimeGraphEntry
) {
375 fTimeGraphViewer
.setSelection((ITimeGraphEntry
) selection
);
377 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
378 if (treeItems
.size() == 0) {
381 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
382 tree
.setTopItem(treeItem
);
387 fTimeGraphViewer
.addSelectionListener(new ITimeGraphSelectionListener() {
389 public void selectionChanged(TimeGraphSelectionEvent event
) {
390 ITimeGraphEntry entry
= fTimeGraphViewer
.getSelection();
391 fInhibitTreeSelection
= true; // block the tree selection changed listener
393 StructuredSelection selection
= new StructuredSelection(entry
);
394 fTreeViewer
.setSelection(selection
);
396 fTreeViewer
.setSelection(new StructuredSelection());
398 fInhibitTreeSelection
= false;
399 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
400 if (treeItems
.size() == 0) {
403 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
404 tree
.setTopItem(treeItem
);
408 fTimeGraphViewer
.getVerticalBar().addSelectionListener(new SelectionAdapter() {
410 public void widgetSelected(SelectionEvent e
) {
411 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
412 if (treeItems
.size() == 0) {
415 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
416 tree
.setTopItem(treeItem
);
420 fTimeGraphViewer
.getTimeGraphControl().addMouseWheelListener(new MouseWheelListener() {
422 public void mouseScrolled(MouseEvent e
) {
423 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
424 if (treeItems
.size() == 0) {
427 TreeItem treeItem
= treeItems
.get(fTimeGraphViewer
.getTopIndex());
428 tree
.setTopItem(treeItem
);
432 fNumFillerRows
= Display
.getDefault().getBounds().height
/ getItemHeight(tree
);
434 sash
.setWeights(new int[] { 1, 1 });
437 private ArrayList
<TreeItem
> getVisibleExpandedItems(Tree tree
) {
438 ArrayList
<TreeItem
> items
= new ArrayList
<TreeItem
>();
439 for (TreeItem item
: tree
.getItems()) {
440 if (item
.getData() == FILLER
) {
444 if (item
.getExpanded()) {
445 items
.addAll(getVisibleExpandedItems(item
));
451 private ArrayList
<TreeItem
> getVisibleExpandedItems(TreeItem treeItem
) {
452 ArrayList
<TreeItem
> items
= new ArrayList
<TreeItem
>();
453 for (TreeItem item
: treeItem
.getItems()) {
455 if (item
.getExpanded()) {
456 items
.addAll(getVisibleExpandedItems(item
));
462 // ------------------------------------------------------------------------
464 // ------------------------------------------------------------------------
467 * Returns this time graph combo's tree viewer.
469 * @return the tree viewer
471 public TreeViewer
getTreeViewer() {
476 * Returns this time graph combo's time graph viewer.
478 * @return the time graph viewer
480 public TimeGraphViewer
getTimeGraphViewer() {
481 return fTimeGraphViewer
;
484 // ------------------------------------------------------------------------
486 // ------------------------------------------------------------------------
489 * @see org.eclipse.swt.widgets.Control#redraw()
492 public void redraw() {
493 fTimeGraphViewer
.getControl().redraw();
497 // ------------------------------------------------------------------------
499 // ------------------------------------------------------------------------
501 public int getItemHeight(final Tree tree
) {
503 * Bug in Linux. The method getItemHeight doesn't always return the correct value.
505 if (fLinuxItemHeight
>= 0 && System
.getProperty("os.name").contains("Linux")) { //$NON-NLS-1$ //$NON-NLS-2$
506 if (fLinuxItemHeight
!= 0) {
507 return fLinuxItemHeight
;
509 ArrayList
<TreeItem
> treeItems
= getVisibleExpandedItems(tree
);
510 if (treeItems
.size() > 1) {
511 final TreeItem treeItem0
= treeItems
.get(0);
512 final TreeItem treeItem1
= treeItems
.get(1);
513 PaintListener paintListener
= new PaintListener() {
515 public void paintControl(PaintEvent e
) {
516 tree
.removePaintListener(this);
517 int y0
= treeItem0
.getBounds().y
;
518 int y1
= treeItem1
.getBounds().y
;
519 int itemHeight
= y1
- y0
;
520 if (itemHeight
> 0) {
521 fLinuxItemHeight
= itemHeight
;
522 fTimeGraphViewer
.setItemHeight(itemHeight
);
526 tree
.addPaintListener(paintListener
);
529 fLinuxItemHeight
= -1; // Not Linux, don't perform os.name check anymore
531 return tree
.getItemHeight();
534 // ------------------------------------------------------------------------
536 // ------------------------------------------------------------------------
539 * Sets the tree content provider used by this time graph combo.
541 * @param contentProvider the tree content provider
543 public void setTreeContentProvider(ITreeContentProvider contentProvider
) {
544 fTreeViewer
.setContentProvider(new TreeContentProviderWrapper(contentProvider
));
548 * Sets the tree label provider used by this time graph combo.
550 * @param treeLabelProvider the tree label provider
552 public void setTreeLabelProvider(ITableLabelProvider labelProvider
) {
553 fTreeViewer
.setLabelProvider(new TreeLabelProviderWrapper(labelProvider
));
557 * Sets the tree columns for this time graph combo.
559 * @param columnNames the tree column names
561 public void setTreeColumns(String
[] columnNames
) {
562 final Tree tree
= fTreeViewer
.getTree();
563 for (String columnName
: columnNames
) {
564 TreeColumn column
= new TreeColumn(tree
, SWT
.LEFT
);
565 column
.setText(columnName
);
572 * Sets the time graph provider used by this time graph combo.
574 * @param timeGraphProvider the time graph provider
576 public void setTimeGraphProvider(ITimeGraphPresentationProvider timeGraphProvider
) {
577 fTimeGraphViewer
.setTimeGraphProvider(timeGraphProvider
);
581 * Sets or clears the input for this time graph combo.
582 * The input array should only contain top-level elements.
584 * @param input the input of this time graph combo, or <code>null</code> if none
586 public void setInput(ITimeGraphEntry
[] input
) {
587 fTreeViewer
.setInput(input
);
588 fTreeViewer
.expandAll();
589 fTreeViewer
.getTree().getVerticalBar().setEnabled(false);
590 fTreeViewer
.getTree().getVerticalBar().setVisible(false);
591 fTimeGraphViewer
.setItemHeight(getItemHeight(fTreeViewer
.getTree()));
592 fTimeGraphViewer
.setInput(input
);
596 * Refreshes this time graph completely with information freshly obtained from its model.
598 public void refresh() {
599 fTreeViewer
.refresh();
600 fTimeGraphViewer
.refresh();
604 * Adds a listener for selection changes in this time graph combo.
606 * @param listener a selection listener
608 public void addSelectionListener(ITimeGraphSelectionListener listener
) {
609 SelectionListenerWrapper listenerWrapper
= new SelectionListenerWrapper(listener
);
610 fTreeViewer
.addSelectionChangedListener(listenerWrapper
);
611 fSelectionListenerMap
.put(listener
, listenerWrapper
);
612 fTimeGraphViewer
.addSelectionListener(listenerWrapper
);
616 * Removes the given selection listener from this time graph combo.
618 * @param listener a selection changed listener
620 public void removeSelectionListener(ITimeGraphSelectionListener listener
) {
621 SelectionListenerWrapper listenerWrapper
= fSelectionListenerMap
.remove(listener
);
622 fTreeViewer
.removeSelectionChangedListener(listenerWrapper
);
623 fTimeGraphViewer
.removeSelectionListener(listenerWrapper
);