/*******************************************************************************
* Copyright (c) 2008, 2018 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Pawel Piech (Wind River) - adapted breadcrumb for use in Debug view (Bug 252677)
*******************************************************************************/
package org.eclipse.debug.internal.ui.viewers.breadcrumb;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.ListenerList;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ITreePathContentProvider;
import org.eclipse.jface.viewers.ITreePathLabelProvider;
import org.eclipse.jface.viewers.OpenEvent;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.jface.viewers.TreeSelection;
import org.eclipse.jface.viewers.ViewerLabel;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.MenuDetectEvent;
import org.eclipse.swt.events.MenuDetectListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Widget;
/**
* A breadcrumb viewer shows a the parent chain of its input element in a list. Each breadcrumb item
* of that list can be expanded and a sibling of the element presented by the breadcrumb item can be
* selected.
*
* Content providers for breadcrumb viewers must implement the ITreePathContentProvider
* interface.
*
*
* Label providers for breadcrumb viewers must implement the ITreePathLabelProvider interface.
*
*
* @since 3.5
*/
public abstract class BreadcrumbViewer extends StructuredViewer {
private static final boolean IS_GTK= "gtk".equals(SWT.getPlatform()); //$NON-NLS-1$
private final int fStyle;
private final Composite fContainer;
private final ArrayList fBreadcrumbItems;
private final ListenerList fMenuListeners;
private Image fGradientBackground;
private BreadcrumbItem fSelectedItem;
/**
* Create a new BreadcrumbViewer.
*
* Style is one of:
*
*
SWT.NONE
*
SWT.VERTICAL
*
SWT.HORIZONTAL
*
SWT.BOTTOM
*
SWT.RIGHT
*
*
* @param parent the container for the viewer
* @param style the style flag used for this viewer
*/
public BreadcrumbViewer(Composite parent, int style) {
fStyle = style;
fBreadcrumbItems = new ArrayList<>();
fMenuListeners= new ListenerList<>();
fContainer= new Composite(parent, SWT.NONE);
GridData layoutData= new GridData(SWT.FILL, SWT.TOP, true, false);
fContainer.setLayoutData(layoutData);
fContainer.addTraverseListener(e -> e.doit = true);
fContainer.setBackgroundMode(SWT.INHERIT_DEFAULT);
hookControl(fContainer);
int columns= 1000;
if ((SWT.VERTICAL & style) != 0) {
columns= 2;
}
GridLayout gridLayout= new GridLayout(columns, false);
gridLayout.marginWidth= 0;
gridLayout.marginHeight= 0;
gridLayout.verticalSpacing= 0;
gridLayout.horizontalSpacing= 0;
fContainer.setLayout(gridLayout);
fContainer.addListener(SWT.Resize, event -> {
updateSize();
fContainer.layout(true, true);
});
}
int getStyle() {
return fStyle;
}
/**
* Configure the given drop down viewer. The given input is used for the viewers input. Clients
* must at least set the label and the content provider for the viewer.
* @param parent the parent composite
* @param site the site to create the drop down for
* @param path the path to show
* @return the drop down control
*/
protected abstract Control createDropDown(Composite parent, IBreadcrumbDropDownSite site, TreePath path);
/*
* @see org.eclipse.jface.viewers.Viewer#getControl()
*/
@Override
public Control getControl() {
return fContainer;
}
/*
* @see org.eclipse.jface.viewers.StructuredViewer#reveal(java.lang.Object)
*/
@Override
public void reveal(Object element) {
//all elements are always visible
}
/**
* Transfers the keyboard focus into the viewer.
*/
public void setFocus() {
fContainer.setFocus();
if (fSelectedItem != null) {
fSelectedItem.setFocus(true);
} else {
if (fBreadcrumbItems.size() == 0) {
return;
}
BreadcrumbItem item= fBreadcrumbItems.get(fBreadcrumbItems.size() - 1);
item.setFocus(true);
}
}
/**
* @return true if any of the items in the viewer is expanded
*/
public boolean isDropDownOpen() {
for (int i= 0, size= fBreadcrumbItems.size(); i < size; i++) {
BreadcrumbItem item= fBreadcrumbItems.get(i);
if (item.isMenuShown()) {
return true;
}
}
return false;
}
/**
* The shell used for the shown drop down or null
* if no drop down is shown at the moment.
*
* @return the drop downs shell or null
*/
public Shell getDropDownShell() {
for (int i= 0, size= fBreadcrumbItems.size(); i < size; i++) {
BreadcrumbItem item= fBreadcrumbItems.get(i);
if (item.isMenuShown()) {
return item.getDropDownShell();
}
}
return null;
}
/**
* Add the given listener to the set of listeners which will be informed
* when a context menu is requested for a breadcrumb item.
*
* @param listener the listener to add
*/
public void addMenuDetectListener(MenuDetectListener listener) {
fMenuListeners.add(listener);
}
/**
* Remove the given listener from the set of menu detect listeners.
* Does nothing if the listener is not element of the set.
*
* @param listener the listener to remove
*/
public void removeMenuDetectListener(MenuDetectListener listener) {
fMenuListeners.remove(listener);
}
/*
* @see org.eclipse.jface.viewers.StructuredViewer#assertContentProviderType(org.eclipse.jface.viewers.IContentProvider)
*/
@Override
protected void assertContentProviderType(IContentProvider provider) {
super.assertContentProviderType(provider);
Assert.isTrue(provider instanceof ITreePathContentProvider);
}
/*
* @see org.eclipse.jface.viewers.Viewer#inputChanged(java.lang.Object, java.lang.Object)
*/
@Override
protected void inputChanged(final Object input, Object oldInput) {
if (fContainer.isDisposed()) {
return;
}
disableRedraw();
try {
preservingSelection(() -> buildItemChain(input));
} finally {
enableRedraw();
}
}
/*
* @see org.eclipse.jface.viewers.StructuredViewer#doFindInputItem(java.lang.Object)
*/
@Override
protected Widget doFindInputItem(Object element) {
if (element == null) {
return null;
}
if (element == getInput() || element.equals(getInput())) {
return doFindItem(element);
}
return null;
}
/*
* @see org.eclipse.jface.viewers.StructuredViewer#doFindItem(java.lang.Object)
*/
@Override
protected Widget doFindItem(Object element) {
if (element == null) {
return null;
}
for (int i= 0, size= fBreadcrumbItems.size(); i < size; i++) {
BreadcrumbItem item= fBreadcrumbItems.get(i);
if (item.getData() == element || element.equals(item.getData())) {
return item;
}
}
return null;
}
/*
* @see org.eclipse.jface.viewers.StructuredViewer#doUpdateItem(org.eclipse.swt.widgets.Widget, java.lang.Object, boolean)
*/
@Override
protected void doUpdateItem(Widget widget, Object element, boolean fullMap) {
myDoUpdateItem(widget, element, fullMap);
}
private boolean myDoUpdateItem(Widget widget, Object element, boolean fullMap) {
if (widget instanceof BreadcrumbItem) {
final BreadcrumbItem item= (BreadcrumbItem) widget;
// remember element we are showing
if (fullMap) {
associate(element, item);
} else {
Object data= item.getData();
if (data != null) {
unmapElement(data, item);
}
item.setData(element);
mapElement(element, item);
}
refreshItem(item);
}
return false;
}
/**
* This implementation of getSelection() returns an instance of
* ITreeSelection.
* @return the current selection
*/
@Override
public ISelection getSelection() {
Control control = getControl();
if (control == null || control.isDisposed()) {
return TreeSelection.EMPTY;
}
if (fSelectedItem != null) {
TreePath path = getTreePathFromItem(fSelectedItem);
if (path != null) {
return new TreeSelection(new TreePath[] { path });
}
}
return TreeSelection.EMPTY;
}
protected TreePath getTreePathFromItem(BreadcrumbItem item) {
List