taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/view/descriptive/DescriptiveViewPart.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.taxeditor.editor.view.descriptive;
  12
  13 import java.util.HashMap;
  14 import java.util.Map;
  15
  16 import org.eclipse.jface.action.Action;
  17 import org.eclipse.jface.action.GroupMarker;
  18 import org.eclipse.jface.action.IToolBarManager;
  19 import org.eclipse.jface.action.MenuManager;
  20 import org.eclipse.jface.resource.ImageDescriptor;
  21 import org.eclipse.jface.viewers.ISelection;
  22 import org.eclipse.jface.viewers.StructuredSelection;
  23 import org.eclipse.jface.viewers.TreeViewer;
  24 import org.eclipse.jface.viewers.Viewer;
  25 import org.eclipse.swt.SWT;
  26 import org.eclipse.swt.dnd.DND;
  27 import org.eclipse.swt.dnd.Transfer;
  28 import org.eclipse.swt.graphics.ImageData;
  29 import org.eclipse.swt.widgets.Composite;
  30 import org.eclipse.swt.widgets.Control;
  31 import org.eclipse.swt.widgets.Menu;
  32 import org.eclipse.swt.widgets.Tree;
  33 import org.eclipse.ui.IEditorInput;
  34 import org.eclipse.ui.IEditorPart;
  35 import org.eclipse.ui.IWorkbenchActionConstants;
  36 import org.eclipse.ui.IWorkbenchPart;
  37
  38 import eu.etaxonomy.cdm.model.common.CdmBase;
  39 import eu.etaxonomy.cdm.model.description.DescriptionBase;
  40 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
  41 import eu.etaxonomy.cdm.model.description.TaxonDescription;
  42 import eu.etaxonomy.taxeditor.bulkeditor.BulkEditor;
  43 import eu.etaxonomy.taxeditor.editor.EditorUtil;
  44 import eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor;
  45 import eu.etaxonomy.taxeditor.editor.key.AbstractKeyEditor;
  46 import eu.etaxonomy.taxeditor.model.FeatureNodeContainer;
  47 import eu.etaxonomy.taxeditor.model.FeatureNodeContainerTree;
  48 import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;
  49 import eu.etaxonomy.taxeditor.model.IPartContentHasSupplementalData;
  50 import eu.etaxonomy.taxeditor.model.ImageResources;
  51 import eu.etaxonomy.taxeditor.view.AbstractCdmEditorViewPart;
  52
  53 /**
  54  * <p>DescriptiveViewPart class.</p>
  55  *
  56  * @author n.hoffmann
  57  * @created Jun 9, 2010
  58  * @version 1.0
  59  */
  60 public class DescriptiveViewPart extends AbstractCdmEditorViewPart implements IPartContentHasDetails, IPartContentHasSupplementalData {
  61
  62         /** Constant <code>ID="eu.etaxonomy.taxeditor.editor.view.desc"{trunked}</code> */
  63         public static final String ID = "eu.etaxonomy.taxeditor.editor.view.descriptive";
  64
  65         private TreeViewer viewer;
  66
  67         private Map<TaxonDescription, FeatureNodeContainerTree> featureNodeContainerCache = new HashMap<TaxonDescription, FeatureNodeContainerTree>();
  68
  69         private ToggleDescriptionAction showAllElementsAction;
  70
  71         private ToggleDescriptionAction hideAllElementsAction;
  72
  73         private int dndOperations = DND.DROP_COPY | DND.DROP_MOVE;
  74
  75         /** {@inheritDoc} */
  76         @Override
  77         public void createViewer(Composite parent) {
  78
  79                 viewer = new TreeViewer(new Tree(parent, SWT.NULL));
  80
  81                 viewer.setContentProvider(new DescriptiveContentProvider(featureNodeContainerCache));
  82                 viewer.setLabelProvider(new DescriptiveLabelProvider());
  83
  84                 viewer.setSorter(new DescriptiveViewerSorter());
  85
  86                 viewer.setAutoExpandLevel(2);
  87
  88
  89                 Transfer[] transfers = new Transfer[] { DescriptionElementTransfer.getInstance() };
  90                 viewer.addDragSupport(dndOperations, transfers, new DescriptionElementDragListener(
  91                                 this));
  92                 viewer.addDropSupport(dndOperations, transfers,
  93                                 new DescriptionElementDropAdapter(viewer));
  94
  95                 // Propagate selection from viewer
  96                 getSite().setSelectionProvider(viewer);
  97
  98                 showAllElementsAction = new ToggleDescriptionAction(false);
  99                 hideAllElementsAction = new ToggleDescriptionAction(true);
 100
 101                 // Add context menu to tree
 102                 createMenu();
 103
 104                 createToolbar();
 105
 106                 // set initial input
 107 //              if(getEditor() != null){
 108 //                      viewer.setInput(getEditor().getEditorInput());
 109 //              }
 110         }
 111
 112         /* (non-Javadoc)
 113          * @see eu.etaxonomy.taxeditor.model.AbstractCdmViewPart#getInitialSelection()
 114          */
 115         /** {@inheritDoc} */
 116         @Override
 117         protected ISelection getInitialSelection() {
 118                 if(getEditor() != null){
 119                         return new StructuredSelection(getEditor().getEditorInput());
 120                 }
 121
 122                 return super.getInitialSelection();
 123         }
 124
 125         private void createToolbar() {
 126                 IToolBarManager toolBarManager = getViewSite().getActionBars().getToolBarManager();
 127                 toolBarManager.add(showAllElementsAction);
 128                 toolBarManager.add(hideAllElementsAction);
 129         }
 130
 131         /*
 132          * TODO add to the views menu
 133          */
 134         private void createMenu(){
 135                 MenuManager menuManager = new MenuManager();
 136                 menuManager.add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));
 137
 138                 getSite().registerContextMenu(menuManager, viewer);
 139
 140                 // FIXME for some reason this is not working
 141                 menuManager.add(showAllElementsAction);
 142                 menuManager.add(hideAllElementsAction);
 143
 144                 Control control = viewer.getControl();
 145                 Menu menu = menuManager.createContextMenu(control);
 146
 147                 control.setMenu(menu);
 148         }
 149
 150         /** {@inheritDoc} */
 151         public void selectionChanged(IWorkbenchPart part, ISelection selection) {
 152                 if(EditorUtil.getActiveEditor() == null){
 153                         showEmptyPage();
 154                         return;
 155                 }
 156
 157                 if(part instanceof BulkEditor){
 158                         showEmptyPage();
 159                         return;
 160                 }
 161
 162                 if(part instanceof AbstractKeyEditor){
 163                         showEmptyPage();
 164                         return;
 165                 }
 166
 167                 if(part instanceof MultiPageTaxonEditor){
 168                         if(! part.equals(this.part)){
 169                                 IEditorInput input = ((IEditorPart) part).getEditorInput();
 170                                 featureNodeContainerCache.clear();
 171                                 showViewer(part, new StructuredSelection(input));
 172                         }
 173                         showViewer();
 174                 }
 175         }
 176
 177         /**
 178          *
 179          * @author n.hoffmann
 180          * @created May 28, 2010
 181          * @version 1.0
 182          */
 183         private class ToggleDescriptionAction extends Action{
 184                 private boolean expanded;
 185
 186                 public ToggleDescriptionAction(boolean expand){
 187                         super(null, Action.AS_PUSH_BUTTON);
 188                         expanded = expand;
 189                         setImageAndTooltip();
 190                 }
 191
 192                 private void setImageAndTooltip(){
 193                         setImageDescriptor(new ImageDescriptor() {
 194                                 @Override
 195                                 public ImageData getImageData() {
 196                                         setText(expanded ? "Collapse All" : "Expand All");
 197                                         String resource = expanded ? ImageResources.COLLAPSE_ALL : ImageResources.EXPAND_ALL;
 198                                         return ImageResources.getImage(resource).getImageData();
 199                                 }
 200                         });
 201
 202                         String toolTipText = expanded ? "Collapse all" : "Show all descriptive data";
 203                         setToolTipText(toolTipText);
 204                 }
 205
 206                 @Override
 207                 public void run() {
 208                         if(expanded){
 209                                 viewer.collapseAll();
 210                         }else{
 211                                 viewer.expandAll();
 212                         }
 213                         setImageAndTooltip();
 214                 }
 215         }
 216
 217         /** {@inheritDoc} */
 218         @Override
 219         public boolean postOperation(CdmBase objectAffectedByOperation) {
 220                 return super.postOperation(objectAffectedByOperation);
 221         }
 222
 223         /** {@inheritDoc} */
 224         @Override
 225         public void changed(Object object) {
 226                 for(FeatureNodeContainerTree containerTree : featureNodeContainerCache.values()){
 227                         containerTree.buildTree();
 228                 }
 229                 viewer.refresh();
 230
 231                 if(object instanceof DescriptionElementBase){
 232                         DescriptionElementBase descriptionElement = (DescriptionElementBase) object;
 233                         DescriptionBase description = descriptionElement.getInDescription();
 234                         FeatureNodeContainerTree containerTree = featureNodeContainerCache.get(description);
 235
 236                         FeatureNodeContainer featureNodeContainer = containerTree.getFeatureNodeContainerForDescriptionElement(descriptionElement);
 237                         viewer.expandToLevel(featureNodeContainer, 1);
 238
 239                 }
 240
 241                 if(object != null){
 242                         StructuredSelection selection = new StructuredSelection(object);
 243                         viewer.setSelection(selection, true);
 244                 }
 245
 246                 super.changed(object);
 247         }
 248
 249         /** {@inheritDoc} */
 250         @Override
 251         public Viewer getViewer() {
 252                 return viewer;
 253         }
 254
 255         /**
 256          * <p>onComplete</p>
 257          *
 258          * @return a boolean.
 259          */
 260         public boolean onComplete() {
 261                 return false;
 262         }
 263 }