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