/**
* Copyright (c) 2013 Puppet Labs, Inc. and other contributors, as listed below.
* 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:
* 2010 itemis AG (http://www.itemis.eu) - initial API and implementation
* Puppet Labs
*
*/
package com.puppetlabs.geppetto.pp.dsl.ui.editor.findrefs;
import java.util.Iterator;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.util.OpenStrategy;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.OpenEvent;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.search.ui.IContextMenuConstants;
import org.eclipse.search.ui.IQueryListener;
import org.eclipse.search.ui.ISearchQuery;
import org.eclipse.search.ui.ISearchResult;
import org.eclipse.search.ui.ISearchResultPage;
import org.eclipse.search.ui.ISearchResultViewPart;
import org.eclipse.search.ui.NewSearchUI;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IMemento;
import org.eclipse.ui.OpenAndLinkWithEditorHelper;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.part.IPageSite;
import org.eclipse.ui.part.Page;
import org.eclipse.ui.part.PageBook;
import org.eclipse.xtext.resource.IReferenceDescription;
import org.eclipse.xtext.resource.IResourceDescription;
import org.eclipse.xtext.ui.editor.IURIEditorOpener;
import com.google.inject.Inject;
public class PPReferenceSearchViewPage extends Page implements ISearchResultPage {
private String id;
private ISearchResult searchResult;
private PageBook pagebook;
private Table busyLabel;
private Composite control;
private TreeViewer viewer;
private ISearchResultViewPart part;
private IAction showNextAction;
private IAction showPreviousAction;
private IAction expandAllAction;
private IAction collapseAllAction;
@Inject
private ReferenceSearchResultContentProvider contentProvider;
@Inject
private ReferenceSearchResultLabelProvider labelProvider;
@Inject
private ReferenceSearchViewSorter sorter;
@Inject
private IURIEditorOpener uriEditorOpener;
private boolean isBusyShowing;
private IQueryListener queryListener;
public PPReferenceSearchViewPage() {
showPreviousAction = new ReferenceSearchViewPageActions.ShowPrevious(this);
showNextAction = new ReferenceSearchViewPageActions.ShowNext(this);
expandAllAction = new ReferenceSearchViewPageActions.ExpandAll(this);
collapseAllAction = new ReferenceSearchViewPageActions.CollapseAll(this);
}
@Override
public void createControl(Composite parent) {
pagebook = new PageBook(parent, SWT.NULL);
pagebook.setLayoutData(new GridData(GridData.FILL_BOTH));
busyLabel = new Table(pagebook, SWT.NONE);
TableItem item = new TableItem(busyLabel, SWT.NONE);
item.setText("Searching...");
busyLabel.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
control = new Composite(pagebook, SWT.NULL);
control.setLayoutData(new GridData(GridData.FILL_BOTH));
control.setSize(100, 100);
control.setLayout(new FillLayout());
viewer = new TreeViewer(control, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);
viewer.setContentProvider(contentProvider);
viewer.setLabelProvider(labelProvider);
viewer.setSorter(sorter);
createOpenAndLinkWithEditorHandler();
IToolBarManager tbm = getSite().getActionBars().getToolBarManager();
fillToolbar(tbm);
tbm.update(true);
pagebook.showPage(control);
isBusyShowing = false;
queryListener = createQueryListener();
NewSearchUI.addQueryListener(queryListener);
}
protected OpenAndLinkWithEditorHelper createOpenAndLinkWithEditorHandler() {
return new OpenAndLinkWithEditorHelper(viewer) {
@Override
protected void activate(ISelection selection) {
final int currentMode = OpenStrategy.getOpenMethod();
try {
OpenStrategy.setOpenMethod(OpenStrategy.DOUBLE_CLICK);
handleOpen(new OpenEvent(viewer, selection));
}
finally {
OpenStrategy.setOpenMethod(currentMode);
}
}
@Override
protected void linkToEditor(ISelection selection) {
// not supported by this part
}
@Override
protected void open(ISelection selection, boolean activate) {
handleOpen(new OpenEvent(viewer, selection));
}
};
}
protected IQueryListener createQueryListener() {
return new IQueryListener() {
public void queryAdded(ISearchQuery query) {
showBusyLabel(false);
}
public void queryFinished(ISearchQuery query) {
showBusyLabel(false);
}
public void queryRemoved(ISearchQuery query) {
showBusyLabel(false);
}
public void queryStarting(ISearchQuery query) {
showBusyLabel(true);
}
};
}
@Override
public void dispose() {
NewSearchUI.removeQueryListener(queryListener);
super.dispose();
}
protected void fillToolbar(IToolBarManager tbm) {
tbm.appendToGroup(IContextMenuConstants.GROUP_SHOW, showNextAction);
tbm.appendToGroup(IContextMenuConstants.GROUP_SHOW, showPreviousAction);
IActionBars actionBars = getSite().getActionBars();
if(actionBars != null) {
actionBars.setGlobalActionHandler(ActionFactory.NEXT.getId(), showNextAction);
actionBars.setGlobalActionHandler(ActionFactory.PREVIOUS.getId(), showPreviousAction);
}
tbm.appendToGroup(IContextMenuConstants.GROUP_VIEWER_SETUP, expandAllAction);
tbm.appendToGroup(IContextMenuConstants.GROUP_VIEWER_SETUP, collapseAllAction);
}
@Override
public Control getControl() {
return pagebook;
}
public String getID() {
return id;
}
public String getLabel() {
return searchResult == null
? ""
: searchResult.getLabel();
}
public Object getUIState() {
return viewer.getSelection();
}
public TreeViewer getViewer() {
return viewer;
}
protected void handleOpen(OpenEvent openEvent) {
ISelection selection = openEvent.getSelection();
if(selection instanceof IStructuredSelection) {
IStructuredSelection structuredSelection = (IStructuredSelection) selection;
for(Iterator<?> i = structuredSelection.iterator(); i.hasNext();) {
Object selectedObject = i.next();
if(selectedObject instanceof ReferenceSearchViewTreeNode) {
ReferenceSearchViewTreeNode treeNode = (ReferenceSearchViewTreeNode) selectedObject;
Object description = treeNode.getDescription();
// open resource or a reference (standard EReference, or the PP way).
if(description instanceof IReferenceDescription) {
IReferenceDescription referenceDescription = (IReferenceDescription) description;
// Asssume that the PP way is always to pass null as EReference
if(referenceDescription.getEReference() != null) {
uriEditorOpener.open(
referenceDescription.getSourceEObjectUri(), referenceDescription.getEReference(),
referenceDescription.getIndexInList(), true);
}
else {
// Do it the PP way.
uriEditorOpener.open(referenceDescription.getSourceEObjectUri(), true);
}
}
else if(description instanceof IResourceDescription) {
uriEditorOpener.open(((IResourceDescription) description).getURI(), true);
}
}
}
}
}
@Override
public void init(IPageSite pageSite) {
super.init(pageSite);
}
public void restoreState(IMemento memento) {
}
public void saveState(IMemento memento) {
}
@Override
public void setFocus() {
Control control = viewer.getControl();
if(control != null && !control.isDisposed())
control.setFocus();
}
public void setID(String id) {
this.id = id;
}
public void setInput(ISearchResult newSearchResult, Object uiState) {
synchronized(viewer) {
this.searchResult = newSearchResult;
if(searchResult != null) {
viewer.setInput(newSearchResult);
if(uiState instanceof ISelection) {
viewer.setSelection((ISelection) uiState);
}
}
part.updateLabel();
}
}
public void setViewPart(ISearchResultViewPart part) {
this.part = part;
}
protected void showBusyLabel(final boolean shouldShowBusy) {
if(shouldShowBusy != isBusyShowing) {
Display.getDefault().asyncExec(new Runnable() {
public void run() {
if(shouldShowBusy)
pagebook.showPage(busyLabel);
else
pagebook.showPage(control);
}
});
isBusyShowing = shouldShowBusy;
}
}
}