eu.etaxonomy.taxeditor.editor/src/main/java/eu/etaxonomy/taxeditor/editor/view/descriptive/e4/FactualDataPartE4.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2017 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 package eu.etaxonomy.taxeditor.editor.view.descriptive.e4;
  11
  12 import java.util.Arrays;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16
  17 import javax.annotation.PostConstruct;
  18 import javax.inject.Inject;
  19
  20 import org.eclipse.e4.core.contexts.ContextInjectionFactory;
  21 import org.eclipse.e4.core.contexts.IEclipseContext;
  22 import org.eclipse.e4.core.di.annotations.Optional;
  23 import org.eclipse.e4.ui.di.UIEventTopic;
  24 import org.eclipse.e4.ui.model.application.ui.basic.MPart;
  25 import org.eclipse.e4.ui.services.EMenuService;
  26 import org.eclipse.jface.viewers.AbstractTreeViewer;
  27 import org.eclipse.jface.viewers.IStructuredSelection;
  28 import org.eclipse.jface.viewers.ITreeContentProvider;
  29 import org.eclipse.jface.viewers.StructuredSelection;
  30 import org.eclipse.jface.viewers.TreeNode;
  31 import org.eclipse.jface.viewers.TreeViewer;
  32 import org.eclipse.swt.SWT;
  33 import org.eclipse.swt.dnd.DND;
  34 import org.eclipse.swt.dnd.Transfer;
  35 import org.eclipse.swt.widgets.Composite;
  36 import org.eclipse.swt.widgets.Tree;
  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.IDescribable;
  42 import eu.etaxonomy.cdm.model.name.TaxonName;
  43 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  44 import eu.etaxonomy.taxeditor.bulkeditor.e4.BulkEditorE4;
  45 import eu.etaxonomy.taxeditor.editor.l10n.Messages;
  46 import eu.etaxonomy.taxeditor.editor.name.e4.TaxonNameEditorE4;
  47 import eu.etaxonomy.taxeditor.editor.view.concept.e4.ConceptViewPartE4;
  48 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptionElementDragListener;
  49 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptionElementDropAdapter;
  50 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptionElementTransfer;
  51 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptiveContentProvider;
  52 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptiveLabelProvider;
  53 import eu.etaxonomy.taxeditor.editor.view.descriptive.DescriptiveViewerSorter;
  54 import eu.etaxonomy.taxeditor.editor.view.media.e4.MediaViewPartE4;
  55 import eu.etaxonomy.taxeditor.event.WorkbenchEventConstants;
  56 import eu.etaxonomy.taxeditor.model.FeatureNodeContainer;
  57 import eu.etaxonomy.taxeditor.model.FeatureNodeContainerTree;
  58 import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;
  59 import eu.etaxonomy.taxeditor.model.IPartContentHasFactualData;
  60 import eu.etaxonomy.taxeditor.model.IPartContentHasSupplementalData;
  61 import eu.etaxonomy.taxeditor.session.ICdmEntitySession;
  62 import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;
  63 import eu.etaxonomy.taxeditor.view.e4.AbstractCdmEditorPartE4;
  64 import eu.etaxonomy.taxeditor.view.e4.details.DetailsPartE4;
  65 import eu.etaxonomy.taxeditor.view.e4.supplementaldata.SupplementalDataPartE4;
  66 import eu.etaxonomy.taxeditor.workbench.part.ICollapsableExpandable;
  67
  68 /**
  69  * @author pplitzner
  70  * @date 15.08.2017
  71  *
  72  */
  73 public class FactualDataPartE4 extends AbstractCdmEditorPartE4
  74         implements IPartContentHasDetails, IPartContentHasSupplementalData, ICdmEntitySessionEnabled,
  75         ICollapsableExpandable {
  76
  77     /**
  78      * Maps {@link FeatureNodeContainerTree} to their corresponding {@link TaxonDescritpion}.<br>
  79      * This serves as input for the {@link ITreeContentProvider} of the {@link TreeViewer}
  80      */
  81     protected Map<DescriptionBase<?>, FeatureNodeContainerTree> featureNodeContainerCache = new HashMap<DescriptionBase<?>, FeatureNodeContainerTree>();
  82
  83     protected int dndOperations = DND.DROP_COPY | DND.DROP_MOVE;
  84
  85     private DescriptiveContentProvider provider;
  86
  87     @PostConstruct
  88     public void create(Composite parent, EMenuService menuService, MPart thisPart,
  89             IEclipseContext context) {
  90         TreeViewer treeViewer = new TreeViewer(new Tree(parent, SWT.H_SCROLL
  91                 | SWT.V_SCROLL | SWT.FULL_SELECTION | SWT.MULTI));
  92
  93         this.thisPart = thisPart;
  94
  95         provider = new DescriptiveContentProvider(featureNodeContainerCache);
  96         treeViewer.setContentProvider(provider);
  97         treeViewer.setLabelProvider(new DescriptiveLabelProvider());
  98         treeViewer.setSorter(new DescriptiveViewerSorter());
  99         treeViewer.setAutoExpandLevel(2);
 100         Transfer[] transfers = new Transfer[] { DescriptionElementTransfer.getInstance() };
 101         treeViewer.addDragSupport(dndOperations, transfers, new DescriptionElementDragListener(
 102                 this));
 103
 104
 105         viewer = treeViewer;
 106
 107         // Propagate selection from viewer
 108         selectionChangedListener = (event -> selService.setSelection(event.getSelection()));
 109         viewer.addSelectionChangedListener(selectionChangedListener);
 110         DescriptionElementDropAdapter dropListener = new DescriptionElementDropAdapter(viewer);
 111         ContextInjectionFactory.inject(dropListener, context);
 112         treeViewer.addDropSupport(dndOperations, transfers,
 113                 dropListener);
 114         //create context menu
 115         menuService.registerContextMenu(viewer.getControl(), "eu.etaxonomy.taxeditor.editor.popupmenu.factualDataView");
 116
 117     }
 118
 119     @Override
 120     public void selectionChanged_internal(Object selection, MPart activePart, MPart thisPart) {
 121         if(activePart==thisPart){
 122             return;
 123         }
 124
 125         Object partObject = createPartObject(activePart);
 126
 127
 128
 129         if ((partObject instanceof DetailsPartE4 && !(selection instanceof TaxonName))|| partObject instanceof SupplementalDataPartE4
 130                 || partObject instanceof MediaViewPartE4 || partObject instanceof ConceptViewPartE4) {
 131             // do not show empty page as these views are also used to edit the
 132             // description selected in this view
 133             return;
 134         }
 135
 136
 137         if(partObject instanceof IPartContentHasFactualData ){
 138             if (!viewer.getControl().isDisposed()){
 139                 viewer.getControl().setEnabled(true);
 140             }
 141             IStructuredSelection structuredSelection = createSelection(selection);
 142             if(structuredSelection==null || structuredSelection.isEmpty()){
 143                 showEmptyPage();
 144                 return;
 145             }
 146
 147             Object firstElement = structuredSelection.getFirstElement();
 148             if (partObject instanceof TaxonNameEditorE4){
 149                 if (firstElement != ((TaxonNameEditorE4)partObject).getTaxon()){
 150                     showEmptyPage();
 151                     return;
 152                 }
 153             }
 154
 155             if(firstElement instanceof TreeNode){
 156                 firstElement = ((TreeNode) firstElement).getValue();
 157             }
 158             if(firstElement instanceof IDescribable<?>
 159                 && partObject instanceof IPartContentHasFactualData
 160                     && !(firstElement instanceof SpecimenOrObservationBase && partObject instanceof BulkEditorE4)){
 161                    // && !(firstElement instanceof TaxonName && partObject instanceof BulkEditorE4)){
 162                 if (firstElement instanceof TaxonName){
 163                     thisPart.setLabel(Messages.NameFactsDataView_Lable);
 164                 }else{
 165                     thisPart.setLabel(Messages.FactualDataView_Lable);
 166                 }
 167                 featureNodeContainerCache.clear();
 168                 showViewer(structuredSelection, activePart, viewer);
 169                 return;
 170             }
 171         }
 172         showEmptyPage();
 173         return;
 174     }
 175
 176     @Override
 177     protected String getViewName(){
 178         return Messages.DescriptiveViewPart_FACTUAL_DATA;
 179     }
 180
 181     /** {@inheritDoc} */
 182     @Override
 183     public void changed(Object object) {
 184         for(FeatureNodeContainerTree containerTree : featureNodeContainerCache.values()){
 185             containerTree.buildTree();
 186         }
 187
 188         if(object instanceof DescriptionElementBase){
 189             DescriptionElementBase descriptionElement = (DescriptionElementBase) object;
 190             DescriptionBase description = descriptionElement.getInDescription();
 191             FeatureNodeContainerTree containerTree = featureNodeContainerCache.get(description);
 192
 193             FeatureNodeContainer featureNodeContainer = containerTree.getFeatureNodeContainerForDescriptionElement(descriptionElement);
 194             ((AbstractTreeViewer) viewer).expandToLevel(featureNodeContainer, 1);
 195
 196         }
 197         ((AbstractTreeViewer) viewer).expandToLevel(2);
 198         viewer.refresh();
 199
 200
 201         if(object != null){
 202             StructuredSelection selection = new StructuredSelection(object);
 203             viewer.setSelection(selection, true);
 204         }
 205         super.changed(object);
 206     }
 207
 208     @Inject
 209     @Optional
 210     private void updateView(@UIEventTopic(WorkbenchEventConstants.SAVE_TAXON)boolean refresh){
 211         if(refresh){
 212             viewer.refresh();
 213         }
 214     }
 215
 216     /**
 217      * {@inheritDoc}
 218      */
 219     @Override
 220     public void collapse() {
 221         if(viewer instanceof TreeViewer) {
 222             ((TreeViewer) viewer).collapseAll();
 223         }
 224     }
 225
 226     /**
 227      * {@inheritDoc}
 228      */
 229     @Override
 230     public void expand() {
 231         if(viewer instanceof TreeViewer) {
 232             ((TreeViewer) viewer).expandAll();
 233         }
 234     }
 235
 236     public void toggleShowOnlyIndividualAssociations(){
 237         provider.toggleShowOnlyIndividualAssociations();
 238         viewer.refresh();
 239     }
 240
 241     @Override
 242     public ICdmEntitySession getCdmEntitySession() {
 243         if(selectionProvidingPart != null && selectionProvidingPart instanceof ICdmEntitySessionEnabled) {
 244             return ((ICdmEntitySessionEnabled) selectionProvidingPart).getCdmEntitySession();
 245         }
 246         return null;
 247     }
 248
 249     @Override
 250     public  List<? extends CdmBase> getRootEntities() {
 251         return Arrays.asList((CdmBase)getViewer().getInput());
 252     }
 253     @Override
 254     public Map<Object, List<String>> getPropertyPathsMap() {
 255         return null;
 256     }
 257
 258 }