| /******************************************************************************* |
| * Copyright (c) 2009, 2013 Wind River Systems and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Wind River Systems - initial API and implementation |
| * IBM Corporation - ongoing bug fixes and enhancements |
| *******************************************************************************/ |
| package org.eclipse.debug.internal.ui.viewers.breadcrumb; |
| |
| import java.util.LinkedList; |
| import java.util.List; |
| |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.debug.internal.core.IInternalDebugCoreConstants; |
| import org.eclipse.debug.internal.ui.DebugUIPlugin; |
| import org.eclipse.jface.util.OpenStrategy; |
| import org.eclipse.jface.viewers.IOpenListener; |
| import org.eclipse.jface.viewers.ISelection; |
| import org.eclipse.jface.viewers.ITreeSelection; |
| import org.eclipse.jface.viewers.ITreeViewerListener; |
| import org.eclipse.jface.viewers.OpenEvent; |
| import org.eclipse.jface.viewers.TreeExpansionEvent; |
| import org.eclipse.jface.viewers.TreePath; |
| import org.eclipse.jface.viewers.TreeSelection; |
| import org.eclipse.jface.viewers.TreeViewer; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.events.KeyEvent; |
| import org.eclipse.swt.events.KeyListener; |
| import org.eclipse.swt.events.MouseEvent; |
| import org.eclipse.swt.events.MouseListener; |
| import org.eclipse.swt.events.MouseMoveListener; |
| import org.eclipse.swt.graphics.Point; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| import org.eclipse.swt.widgets.Item; |
| import org.eclipse.swt.widgets.Tree; |
| import org.eclipse.swt.widgets.TreeItem; |
| import org.eclipse.ui.progress.UIJob; |
| |
| /** |
| * A breadcrumb drop-down which shows a tree viewer. It implements mouse and |
| * key listeners to handle selection and expansion behavior of the viewer. |
| * This class needs to be extended to implement |
| * {@link #createTreeViewer(Composite, int, TreePath)} to instantiate the |
| * concrete {@link TreeViewer} object. |
| * |
| * @since 3.5 |
| */ |
| public abstract class TreeViewerDropDown { |
| |
| /** |
| * Delay to control scrolling when the mouse pointer reaches the edge of |
| * the tree viewer. |
| */ |
| private static long MOUSE_MOVE_SCROLL_DELAY = 500; |
| |
| /** |
| * The breadcrumb site in which the viewer is created. |
| */ |
| private IBreadcrumbDropDownSite fDropDownSite; |
| |
| /** |
| * The tree viewer. |
| */ |
| private TreeViewer fDropDownViewer; |
| |
| /** |
| * Creates the viewer and installs the listeners. |
| * |
| * @param composite Parent control of the viewer. |
| * @param site Breadcrumb site for the viewer. |
| * @param path Path to the element for which the drop-down is being opened. |
| * @return The control created for the viewer. |
| */ |
| public Control createDropDown(Composite composite, IBreadcrumbDropDownSite site, TreePath path) { |
| |
| fDropDownSite = site; |
| fDropDownViewer= createTreeViewer(composite, SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL, path); |
| |
| fDropDownViewer.addOpenListener(new IOpenListener() { |
| @Override |
| public void open(OpenEvent event) { |
| if (DebugUIPlugin.DEBUG_TREE_VIEWER_DROPDOWN) { |
| DebugUIPlugin.trace("BreadcrumbItemDropDown.showMenu()$treeViewer>open"); //$NON-NLS-1$ |
| } |
| openElement(event.getSelection()); |
| } |
| }); |
| |
| final Tree tree = fDropDownViewer.getTree(); |
| |
| tree.addMouseListener(new MouseListener() { |
| @Override |
| public void mouseUp(MouseEvent e) { |
| if (DebugUIPlugin.DEBUG_TREE_VIEWER_DROPDOWN) { |
| DebugUIPlugin.trace("BreadcrumbItemDropDown.showMenu()$treeViewer>mouseUp"); //$NON-NLS-1$ |
| } |
| if (e.button != 1) { |
| return; |
| } |
| |
| if ((OpenStrategy.getOpenMethod() & OpenStrategy.SINGLE_CLICK) != 0) { |
| return; |
| } |
| |
| TreeItem item= tree.getItem(new Point(e.x, e.y)); |
| if (item == null) { |
| return; |
| } |
| |
| List<Object> pathElements = new LinkedList<>(); |
| while(item != null) { |
| Object data = item.getData(); |
| if (data == null) { |
| return; |
| } |
| pathElements.add(0, data); |
| item = item.getParentItem(); |
| } |
| |
| openElement(new TreeSelection(new TreePath(pathElements.toArray()))); |
| } |
| |
| @Override |
| public void mouseDown(MouseEvent e) { |
| } |
| |
| @Override |
| public void mouseDoubleClick(MouseEvent e) { |
| } |
| }); |
| |
| tree.addMouseMoveListener(new MouseMoveListener() { |
| TreeItem fLastItem= null; |
| long fLastScrollTime = 0; |
| |
| @Override |
| public void mouseMove(MouseEvent e) { |
| if (tree.equals(e.getSource())) { |
| TreeItem currentItem = tree.getItem(new Point(e.x, e.y)); |
| if (fLastItem == null ^ currentItem == null) { |
| tree.setCursor(currentItem == null ? null : tree.getDisplay() |
| .getSystemCursor(SWT.CURSOR_HAND)); |
| } |
| if (currentItem != null) { |
| if (!currentItem.equals(fLastItem)) { |
| fLastItem = currentItem; |
| tree.setSelection(new TreeItem[] { fLastItem }); |
| } else if (System.currentTimeMillis() > (fLastScrollTime + MOUSE_MOVE_SCROLL_DELAY)) { |
| if (e.y < tree.getItemHeight() / 4) |
| { |
| // Scroll up |
| if (currentItem.getParentItem() == null) { |
| int index = tree.indexOf(currentItem); |
| if (index < 1) { |
| return; |
| } |
| |
| fLastItem= tree.getItem(index - 1); |
| tree.setSelection(new TreeItem[] { fLastItem }); |
| } else { |
| Point p= tree.toDisplay(e.x, e.y); |
| Item item= fDropDownViewer.scrollUp(p.x, p.y); |
| fLastScrollTime = System.currentTimeMillis(); |
| if (item instanceof TreeItem) { |
| fLastItem= (TreeItem) item; |
| tree.setSelection(new TreeItem[] { fLastItem }); |
| } |
| } |
| } else if (e.y > tree.getBounds().height - tree.getItemHeight() / 4) { |
| // Scroll down |
| if (currentItem.getParentItem() == null) { |
| int index = tree.indexOf(currentItem); |
| if (index >= tree.getItemCount() - 1) { |
| return; |
| } |
| |
| fLastItem= tree.getItem(index + 1); |
| tree.setSelection(new TreeItem[] { fLastItem }); |
| } else { |
| Point p= tree.toDisplay(e.x, e.y); |
| Item item= fDropDownViewer.scrollDown(p.x, p.y); |
| fLastScrollTime = System.currentTimeMillis(); |
| if (item instanceof TreeItem) { |
| fLastItem= (TreeItem) item; |
| tree.setSelection(new TreeItem[] { fLastItem }); |
| } |
| } |
| } |
| } |
| } else { |
| fLastItem = null; |
| } |
| } |
| } |
| }); |
| |
| tree.addKeyListener(new KeyListener() { |
| @Override |
| public void keyPressed(KeyEvent e) { |
| if (e.keyCode == SWT.ARROW_UP) { |
| // No elements in the tree (bug 262961). |
| if (tree.getItemCount() == 0) { |
| fDropDownSite.close(); |
| return; |
| } |
| |
| TreeItem[] selection= tree.getSelection(); |
| if (selection.length != 1) { |
| return; |
| } |
| |
| int selectionIndex= tree.indexOf(selection[0]); |
| if (selectionIndex != 0) { |
| return; |
| } |
| |
| fDropDownSite.close(); |
| } |
| } |
| |
| @Override |
| public void keyReleased(KeyEvent e) { |
| } |
| }); |
| |
| fDropDownViewer.addTreeListener(new ITreeViewerListener() { |
| @Override |
| public void treeCollapsed(TreeExpansionEvent event) { |
| } |
| |
| @Override |
| public void treeExpanded(TreeExpansionEvent event) { |
| tree.setRedraw(false); |
| new UIJob(tree.getDisplay(), IInternalDebugCoreConstants.EMPTY_STRING) { |
| { setSystem(true); } |
| @Override |
| public IStatus runInUIThread(IProgressMonitor monitor) { |
| if (!tree.isDisposed()) { |
| try { |
| fDropDownSite.updateSize(); |
| } finally { |
| tree.setRedraw(true); |
| } |
| } |
| return Status.OK_STATUS; |
| } |
| }.schedule(); |
| } |
| |
| }); |
| |
| return tree; |
| } |
| |
| /** |
| * Creates and returns the tree viewer. |
| * |
| * @param composite Parent control of the viewer. |
| * @param style Style flags to use in creating the tree viewer. |
| * @param path Path to the element for which the drop-down is being opened. |
| * @return The newly created tree viewer. |
| */ |
| protected abstract TreeViewer createTreeViewer(Composite composite, int style, TreePath path); |
| |
| /** |
| * Called when the given element was selected in the viewer. It causes the |
| * breadcrumb viewer to fire an opened event. If the viewer loses focus |
| * as a result of the open operation, then the drop-down is closed. |
| * Otherwise the selected element is expanded. |
| * |
| * @param selection The selection to open. |
| */ |
| protected void openElement(ISelection selection) { |
| if (selection == null || !(selection instanceof ITreeSelection) || selection.isEmpty()) { |
| return; |
| } |
| |
| // This might or might not open an editor |
| fDropDownSite.notifySelection(selection); |
| |
| Tree tree = fDropDownViewer.getTree(); |
| |
| boolean treeHasFocus= !tree.isDisposed() && tree.isFocusControl(); |
| |
| if (DebugUIPlugin.DEBUG_TREE_VIEWER_DROPDOWN) { |
| DebugUIPlugin.trace(" isDisposed: " + tree.isDisposed()); //$NON-NLS-1$ |
| DebugUIPlugin.trace(" shell hasFocus: " + (!tree.isDisposed() && tree.isFocusControl())); //$NON-NLS-1$ |
| DebugUIPlugin.trace(" tree hasFocus: " + treeHasFocus); //$NON-NLS-1$ |
| } |
| |
| if (tree.isDisposed()) { |
| return; |
| } |
| |
| if (!treeHasFocus) { |
| fDropDownSite.close(); |
| return; |
| } |
| |
| toggleExpansionState( ((ITreeSelection)selection).getPaths()[0]); |
| } |
| |
| private void toggleExpansionState(TreePath path) { |
| Tree tree= fDropDownViewer.getTree(); |
| if (fDropDownViewer.getExpandedState(path)) { |
| fDropDownViewer.collapseToLevel(path, 1); |
| } else { |
| tree.setRedraw(false); |
| try { |
| fDropDownViewer.expandToLevel(path, 1); |
| fDropDownSite.updateSize(); |
| } finally { |
| tree.setRedraw(true); |
| } |
| } |
| } |
| |
| |
| |
| } |
