DependencyViewEditor.java

/*******************************************************************************
 * Copyright (c) 2012 Bundlemaker project team.
 * 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:
 *     Bundlemaker project team - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.tutorial.dependencyviewer;

import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import org.bundlemaker.core.analysis.IBundleMakerArtifact;
import org.bundlemaker.core.analysis.IDependency;
import org.bundlemaker.core.selection.IArtifactSelection;
import org.bundlemaker.core.selection.Selection;
import org.bundlemaker.core.ui.event.selection.workbench.editor.AbstractArtifactSelectionAwareEditorPart;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.zest.core.viewers.AbstractZoomableViewer;
import org.eclipse.zest.core.viewers.GraphViewer;
import org.eclipse.zest.core.viewers.IZoomableWorkbenchPart;
import org.eclipse.zest.core.viewers.ZoomContributionViewItem;
import org.eclipse.zest.layouts.LayoutAlgorithm;
import org.eclipse.zest.layouts.algorithms.CompositeLayoutAlgorithm;
import org.eclipse.zest.layouts.algorithms.DirectedGraphLayoutAlgorithm;
import org.eclipse.zest.layouts.algorithms.HorizontalShiftAlgorithm;

/**
 * @author Nils Hartmann (nils@nilshartmann.net)
 * 
 */
public class DependencyViewEditor extends AbstractArtifactSelectionAwareEditorPart implements IZoomableWorkbenchPart {

  public final static String              DEPENDENCY_VIEW_EDITOR_ID = DependencyViewEditor.class.getName();

  private GraphViewer                     _graphViewer;

  private DependencyViewerContentProvider _contentProvider;

  private DependencyViewerModel           _model;

  /*
   * (non-Javadoc)
   * 
   * @see org.bundlemaker.core.analysis.IAnalysisModelModifiedListener#analysisModelModified()
   */
  @Override
  public void analysisModelModified() {
    setCurrentArtifactSelection(getCurrentArtifactSelection());
  }

  /*
   * (non-Javadoc)
   * 
   * @see org.bundlemaker.core.ui.event.selection.workbench.editor.AbstractArtifactSelectionAwareEditorPart#
   * setCurrentArtifactSelection(org.bundlemaker.core.ui.event.selection.IArtifactSelection)
   */
  @Override
  protected void setCurrentArtifactSelection(IArtifactSelection artifactSelection) {
    super.setCurrentArtifactSelection(artifactSelection);

    //
    List<IBundleMakerArtifact> selectedArtifacts = artifactSelection.getEffectiveSelectedArtifacts();
    _model.setArtifacts(selectedArtifacts);
  }

  /*
   * (non-Javadoc)
   * 
   * @see
   * org.bundlemaker.core.ui.event.selection.workbench.editor.AbstractArtifactSelectionAwareEditorPart#getProviderId()
   */
  @Override
  protected String getProviderId() {
    return DEPENDENCY_VIEW_EDITOR_ID;
  }

  private ToolBar _toolBar;

  /*
   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)
   */
  @Override
  public void createPartControl(Composite parent) {

    _model = new DependencyViewerModel();

    //
    GridLayout gridLayout = new GridLayout(1, true);
    parent.setLayout(gridLayout);

    _toolBar = new ToolBar(parent, SWT.HORIZONTAL);
    GridDataFactory.swtDefaults().grab(true, false).align(SWT.FILL, SWT.CENTER).applyTo(_toolBar);

    _graphViewer = new GraphViewer(parent, SWT.BORDER);
    GridDataFactory.swtDefaults().grab(true, true).align(SWT.FILL, SWT.FILL).applyTo(_graphViewer.getControl());

    _contentProvider = new DependencyViewerContentProvider(_model);
    _graphViewer.setContentProvider(_contentProvider);
    _graphViewer.setLabelProvider(new DependencyViewerLabelProvider(_model));
    _graphViewer.setInput(null);
    // _graphViewer.setFilters(new ViewerFilter[] { new SelectedArtifactViewerFilter() });
    _graphViewer.setLayoutAlgorithm(new CompositeLayoutAlgorithm(new LayoutAlgorithm[] {
        new DirectedGraphLayoutAlgorithm(), new HorizontalShiftAlgorithm() }));
    _graphViewer.setFilters(new ViewerFilter[] { new SelectedArtifactViewerFilter() });
    _graphViewer.applyLayout();
    _graphViewer.addDoubleClickListener(new DependencyNodeDoubleClickListener());
    _graphViewer.addSelectionChangedListener(new ISelectionChangedListener() {

      @Override
      public void selectionChanged(SelectionChangedEvent event) {
        IStructuredSelection structuredSelection = (IStructuredSelection) event.getSelection();
        Object o = structuredSelection.getFirstElement();
        if (o instanceof IDependency) {
          IDependency dependency = (IDependency) o;

          Selection.instance().getDependencySelectionService()
              .setSelection(Selection.MAIN_DEPENDENCY_SELECTION_ID, DEPENDENCY_VIEW_EDITOR_ID, dependency);
        }
      }
    });

    fillToolBar();
    hookContextMenu();

    _model.addDependencyViewerModelChangeListener(new IDependencyViewerModelChangeListener() {

      @Override
      public void modelChanged() {
        _graphViewer.setInput(_model.getArtifacts());
        _graphViewer.refresh();
        _graphViewer.applyLayout();
      }
    });

    if (getCurrentArtifactSelection().hasSelectedArtifacts()) {
      _model.setArtifacts(getCurrentArtifactSelection().getEffectiveSelectedArtifacts());
    }
  }

  private void hookContextMenu() {
    MenuManager menuMgr = new MenuManager("#PopupMenu");
    menuMgr.setRemoveAllWhenShown(true);
    menuMgr.addMenuListener(new IMenuListener() {
      @Override
      public void menuAboutToShow(IMenuManager manager) {
        DependencyViewEditor.this.fillContextMenu(manager);
      }
    });
    Menu menu = menuMgr.createContextMenu(_graphViewer.getControl());
    _graphViewer.getControl().setMenu(menu);
    // getSite().registerContextMenu(menuMgr, _viewer);
  }

  protected void fillContextMenu(IMenuManager manager) {

    final IStructuredSelection selection = (IStructuredSelection) _graphViewer.getSelection();

    final Object firstElement = selection.getFirstElement();

    boolean enabled = firstElement instanceof IBundleMakerArtifact;

    Action backAction = new Action("Back") {
      @Override
      public void run() {
        _model.showPreviousSnapshot();
      }
    };

    Action nextAction = new Action("Next") {
      @Override
      public void run() {
        _model.showNextSnapshot();
      }
    };

    Action hideNodeAction = new Action("Hide node") {

      @Override
      public void run() {
        IBundleMakerArtifact bundleMakerArtifact = (IBundleMakerArtifact) firstElement;
        _model.hideArtifacts(bundleMakerArtifact);
      }

    };

    Action showHiddenNodesAction = new Action("Show hidden nodes") {

      @Override
      public void run() {
        _model.clearHiddenNodes();
      }

    };

    Action focusAction = new Action("Focus on node") {

      @Override
      public void run() {
        List<IBundleMakerArtifact> artifacts = new LinkedList<IBundleMakerArtifact>();
        Iterator<?> iterator = selection.iterator();
        while (iterator.hasNext()) {
          Object o = iterator.next();
          if (o instanceof IBundleMakerArtifact) {
            artifacts.add((IBundleMakerArtifact) o);
          }
        }

        _model.setArtifacts(artifacts);
      }

    };

    Action showDependenciesAction = new Action("Show Dependencies") {
      @Override
      public void run() {
        IBundleMakerArtifact bundleMakerArtifact = (IBundleMakerArtifact) firstElement;

        _model.showDependencies(bundleMakerArtifact);
      }
    };

    Action showContentAction = new Action("Show Content") {
      @Override
      public void run() {

        IBundleMakerArtifact bundleMakerArtifact = (IBundleMakerArtifact) firstElement;

        _model.showArtifactContent(bundleMakerArtifact);
      }

    };

    showContentAction.setEnabled(!selection.isEmpty());
    showDependenciesAction.setEnabled(enabled);
    hideNodeAction.setEnabled(enabled);
    focusAction.setEnabled(!selection.isEmpty());

    backAction.setEnabled(_model.hasPreviousSnapshot());
    nextAction.setEnabled(_model.hasNextSnapshot());

    manager.add(backAction);
    manager.add(nextAction);
    manager.add(new Separator());

    manager.add(focusAction);
    manager.add(new Separator());
    manager.add(showDependenciesAction);
    manager.add(showContentAction);
    manager.add(new Separator());
    manager.add(hideNodeAction);
    manager.add(showHiddenNodesAction);

  }

  /*
   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
   */
  @Override
  public void setFocus() {
    // TODO Auto-generated method stub

  }

  private void fillToolBar() {

    ZoomContributionViewItem toolbarZoomContributionViewItem = new ZoomContributionViewItem(this);
    toolbarZoomContributionViewItem.fill(_toolBar, 0);

    // Button button = new Button(_toolBar, SWT.PUSH);
    // button.setText("Expand");
    // _toolBar.add(new ToolItem(parent, style));

  }

  class SelectedArtifactViewerFilter extends ViewerFilter {

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.Viewer, java.lang.Object,
     * java.lang.Object)
     */
    @Override
    public boolean select(Viewer viewer, Object parentElement, Object element) {

      if (!(element instanceof IBundleMakerArtifact)) {
        return true;
      }

      IBundleMakerArtifact bundleMakerArtifact = (IBundleMakerArtifact) element;

      if (_model.isHiddenArtifact(bundleMakerArtifact)) {
        return false;
      }

      return true;
    }

  }

  /*
   * (non-Javadoc)
   * 
   * @see org.eclipse.zest.core.viewers.IZoomableWorkbenchPart#getZoomableViewer()
   */
  @Override
  public AbstractZoomableViewer getZoomableViewer() {
    return _graphViewer;
  }

  class DependencyNodeDoubleClickListener implements IDoubleClickListener {

    @Override
    public void doubleClick(DoubleClickEvent event) {
      IStructuredSelection sel = (IStructuredSelection) event.getSelection();
      Object s = sel.getFirstElement();

      if (s instanceof IBundleMakerArtifact) {
        IBundleMakerArtifact bundleMakerArtifact = (IBundleMakerArtifact) s;
        _model.showDependencies(bundleMakerArtifact);

      }
    }

  }

}