taxeditor-navigation/src/main/java/eu/etaxonomy/taxeditor/navigation/taxonomictree/TaxonomicTreeView.java

   1 /**
   2  * Copyright (C) 2007 EDIT
   3  * European Distributed Institute of Taxonomy
   4  * http://www.e-taxonomy.eu
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version 1.1
   7  * See LICENSE.TXT at the top of this package for the full license terms.
   8  */
   9
  10 package eu.etaxonomy.taxeditor.navigation.taxonomictree;
  11
  12 import java.util.List;
  13
  14 import org.apache.log4j.Logger;
  15 import org.eclipse.core.commands.operations.IUndoableOperation;
  16 import org.eclipse.jface.action.GroupMarker;
  17 import org.eclipse.jface.action.MenuManager;
  18 import org.eclipse.jface.dialogs.MessageDialog;
  19 import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
  20 import org.eclipse.jface.viewers.DoubleClickEvent;
  21 import org.eclipse.jface.viewers.IDoubleClickListener;
  22 import org.eclipse.jface.viewers.StructuredSelection;
  23 import org.eclipse.jface.viewers.TreeViewer;
  24 import org.eclipse.jface.viewers.ViewerComparator;
  25 import org.eclipse.swt.SWT;
  26 import org.eclipse.swt.dnd.DND;
  27 import org.eclipse.swt.dnd.DragSource;
  28 import org.eclipse.swt.dnd.DragSourceAdapter;
  29 import org.eclipse.swt.dnd.DragSourceEvent;
  30 import org.eclipse.swt.dnd.DropTarget;
  31 import org.eclipse.swt.dnd.DropTargetAdapter;
  32 import org.eclipse.swt.dnd.DropTargetEvent;
  33 import org.eclipse.swt.dnd.Transfer;
  34 import org.eclipse.swt.layout.FillLayout;
  35 import org.eclipse.swt.widgets.Composite;
  36 import org.eclipse.swt.widgets.Control;
  37 import org.eclipse.swt.widgets.Menu;
  38 import org.eclipse.swt.widgets.Tree;
  39 import org.eclipse.swt.widgets.TreeItem;
  40 import org.eclipse.ui.IWorkbenchActionConstants;
  41 import org.eclipse.ui.part.ViewPart;
  42
  43 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  44 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  45 import eu.etaxonomy.cdm.model.common.CdmBase;
  46 import eu.etaxonomy.cdm.model.taxon.Taxon;
  47 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  48 import eu.etaxonomy.taxeditor.navigation.NavigationUtil;
  49 import eu.etaxonomy.taxeditor.store.CdmStore;
  50 import eu.etaxonomy.taxeditor.store.model.DataChangeBridge;
  51 import eu.etaxonomy.taxeditor.store.model.IDataChangeBehavior;
  52 import eu.etaxonomy.taxeditor.store.model.NameUtil;
  53 import eu.etaxonomy.taxeditor.store.model.TaxonTransfer;
  54 import eu.etaxonomy.taxeditor.store.model.TaxonUtil;
  55 import eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled;
  56 import eu.etaxonomy.taxeditor.store.operations.MoveTaxonOperation;
  57
  58 /**
  59  * The panel containing the taxonomic tree.
  60  *
  61  * @author p.ciardelli
  62  * @created 27.05.2008
  63  * @version 1.0
  64  * @author n.hoffmann
  65  */
  66 @Deprecated public class TaxonomicTreeView extends ViewPart implements IConversationEnabled, IPostOperationEnabled {
  67         private static final Logger logger = Logger.getLogger(TaxonomicTreeView.class);
  68
  69         public static final String ID = "eu.etaxonomy.taxeditor.navigation.taxonomictree.treeView"; //$NON-NLS-1$
  70
  71         private TreeViewer treeViewer;
  72
  73         private ConversationHolder conversation;
  74
  75         private IDataChangeBehavior dataChangeBehavior;
  76
  77         private Composite parent;
  78
  79         /**
  80          * Create contents of the view part
  81          * @param parent
  82          */
  83         @Override
  84         public void createPartControl(Composite parent) {
  85                 conversation = CdmStore.NewTransactionalConversation();
  86                 conversation.registerForDataStoreChanges(this);
  87
  88
  89                 if(this.parent == null){
  90                         this.parent = parent;
  91                 }
  92
  93                 // Create top composite
  94                 FillLayout fillLayout = new FillLayout();
  95                 fillLayout.marginWidth = 0;
  96                 fillLayout.marginHeight = 0;
  97                 fillLayout.type = SWT.VERTICAL;
  98                 parent.setLayout(fillLayout);
  99
 100                 createTreeViewer(CdmStore.getDefault().getRootTaxa());
 101         }
 102
 103         /**
 104          * Actual tooltips built in label provider
 105          */
 106         private void createToolTips() {
 107                 ColumnViewerToolTipSupport.enableFor(treeViewer);
 108         }
 109
 110
 111         public void createTreeViewer(List<Taxon> rootTaxa) {
 112
 113                 // Create tree
 114                 treeViewer = new TreeViewer(parent, SWT.VIRTUAL);
 115
 116                 Tree tree = treeViewer.getTree();
 117
 118                 tree.setLinesVisible(false);
 119                 tree.setHeaderVisible(false);
 120
 121                 treeViewer.setContentProvider(new TaxonomicTreeContentProvider());
 122                 treeViewer.setLabelProvider(new TaxonomicTreeLabelProvider());
 123
 124                 treeViewer.setInput(rootTaxa);
 125
 126                 createDoubleClickListener();
 127                 createToolTips();
 128                 createDragAndDrop();
 129
 130                 // Sort according to "getColumnText" above, i.e. by NameCache
 131                 // TODO check if this is still up to date
 132                 treeViewer.setComparator(new ViewerComparator());
 133
 134                 // register context menu
 135                 MenuManager menuMgr = new MenuManager();
 136                 menuMgr.add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));
 137                 getSite().registerContextMenu(menuMgr, treeViewer);
 138
 139                 Control control = treeViewer.getControl();
 140                 Menu menu = menuMgr.createContextMenu(control);
 141                 control.setMenu(menu);
 142
 143         }
 144
 145         /**
 146          * On double click, open name editor
 147          */
 148         public void createDoubleClickListener() {
 149                 treeViewer.addDoubleClickListener(new IDoubleClickListener() {
 150
 151                         public void doubleClick(DoubleClickEvent event) {
 152                                 if (event.getSelection() instanceof StructuredSelection) {
 153                                         Object element = ((StructuredSelection) event
 154                                                         .getSelection()).getFirstElement();
 155                                         if (element instanceof Taxon) {
 156                                                 // FIXME call EditTaxonHandler
 157                                                 logger.info("Doubleclick on taxon element. Should open editor now");
 158                                                 NavigationUtil.openEditor((Taxon) element);
 159                                         }
 160                                 }
 161                         }
 162                 });
 163         }
 164
 165         /**
 166          *
 167          */
 168         public void createDragAndDrop() {
 169                 final Tree tree = treeViewer.getTree();
 170                 Transfer[] types = new Transfer[] { TaxonTransfer.getInstance() };
 171                 int operations = DND.DROP_MOVE | DND.DROP_COPY | DND.DROP_LINK;
 172
 173                 final DragSource source = new DragSource(tree, operations);
 174                 source.setTransfer(types);
 175                 final TreeItem[] dragSourceItem = new TreeItem[1];
 176                 source.addDragListener(new DragSourceAdapter() {
 177                         public void dragStart(DragSourceEvent event) {
 178                                 TreeItem[] selection = tree.getSelection();
 179                                 if (selection.length > 0) {
 180                                         event.doit = true;
 181                                         dragSourceItem[0] = selection[0];
 182                                 } else {
 183                                         event.doit = false;
 184                                 }
 185                         }
 186
 187                         public void dragSetData(DragSourceEvent event) {
 188                                 Taxon taxon = (Taxon) dragSourceItem[0].getData();
 189                                 TaxonTransfer.getInstance().setTaxon(taxon);
 190                         }
 191                 });
 192
 193                 DropTarget target = new DropTarget(tree, operations);
 194                 target.setTransfer(types);
 195                 target.addDropListener(new DropTargetAdapter() {
 196                         public void drop(DropTargetEvent event) {
 197
 198                                 // Only drop ONTO another TreeItem OR outside the tree area.
 199                                 // Dropping between TreeItems makes no sense because tree is
 200                                 // sorted.
 201                                 Taxon taxon = (Taxon) dragSourceItem[0].getData();
 202                                 Taxon newParentTaxon = null;
 203
 204                                 // If event.item == null, user has dragged outside of the tree
 205                                 if (event.item == null) {
 206                                         newParentTaxon = null;
 207                                 } else {
 208                                         newParentTaxon = (Taxon) event.item.getData();
 209
 210                                         // Make sure parentTaxon is not a child
 211                                         if (TaxonUtil.isTaxonChildOfTaxon(newParentTaxon, taxon)) {
 212
 213                                                 MessageDialog.openError(NavigationUtil.getShell(), "Can't move taxon.",
 214                                                                 "'" + NameUtil.getDisplayName(taxon) + "' sits above " +
 215                                                                 "'" + NameUtil.getDisplayName(newParentTaxon) + "' " +
 216                                                                 "in the taxonomic hierarchy.");
 217
 218                                                 return;
 219                                         }
 220
 221                                         // Make sure taxon is not being dropped onto itself
 222                                         if (taxon.equals(newParentTaxon)) {
 223                                                 return;
 224                                         }
 225
 226                                         // Make sure parent taxon does not have unsaved changes
 227                                         if (NavigationUtil.isDirty(newParentTaxon)){
 228                                                 MessageDialog.openWarning(NavigationUtil.getShell(), "Unsaved Parent Taxon", "There are unsaved " +
 229                                                 "changes in the parent taxon. Pleas save first.");
 230                                                 return;
 231                                         }
 232                                 }
 233
 234
 235                                 IUndoableOperation operation = new MoveTaxonOperation
 236                                                 ("Move Taxon", NavigationUtil.getUndoContext(), taxon, newParentTaxon);
 237
 238                                 NavigationUtil.executeOperation(operation);
 239                         }
 240                 });
 241         }
 242
 243         /*
 244          * (non-Javadoc)
 245          * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
 246          */
 247         public void setFocus() {
 248                 // bind resources for this widget on focus
 249                 getConversationHolder().bind();
 250                 // pass focus to the tree viewer if it exists
 251                 if(treeViewer != null){
 252                         treeViewer.getControl().setFocus();
 253                 }
 254         }
 255
 256         /**
 257          * Expose TreeViewer, i.e. to manipulate tree nodes
 258          * @return
 259          */
 260         public TreeViewer getTreeViewer() {
 261                 return treeViewer;
 262         }
 263
 264
 265         /*
 266          * (non-Javadoc)
 267          * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
 268          */
 269         public ConversationHolder getConversationHolder() {
 270                 return conversation;
 271         }
 272
 273         /*
 274          * (non-Javadoc)
 275          * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
 276          */
 277         public void update(CdmDataChangeMap changeEvents) {
 278                 if(dataChangeBehavior == null){
 279                         dataChangeBehavior = new TaxonomicTreeViewDataChangeBehaviour(this);
 280                 }
 281                 DataChangeBridge.handleDataChange(changeEvents, dataChangeBehavior);
 282         }
 283
 284         /**
 285          * Start the creation process of this Control anew.
 286          */
 287         public void recreate() {
 288                 this.createPartControl(parent);
 289         }
 290
 291         /**
 292          * Get a fresh model from CdmStore and refresh the tree viewer with the data
 293          */
 294         public void refresh(){
 295                 treeViewer.setInput(CdmStore.getDefault().getRootTaxa());
 296                 treeViewer.refresh();
 297         }
 298
 299         /* (non-Javadoc)
 300          * @see org.eclipse.ui.part.WorkbenchPart#dispose()
 301          */
 302         @Override
 303         public void dispose() {
 304                 conversation.unregisterForDataStoreChanges(this);
 305
 306                 super.dispose();
 307         }
 308
 309         /**
 310          * If taxon node in the tree is hidden, open and select it
 311          *
 312          * @param taxon
 313          */
 314         public void revealTaxon(Taxon taxon) {
 315                 if (taxon == null) {
 316                         return;
 317                 }
 318                 treeViewer.setSelection(new StructuredSelection(taxon), true);
 319                 treeViewer.reveal(taxon);
 320         }
 321
 322         /* (non-Javadoc)
 323          * @see eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled#postOperation(eu.etaxonomy.cdm.model.common.CdmBase)
 324          */
 325         public boolean postOperation(CdmBase objectAffectedByOperation) {
 326
 327                 if(objectAffectedByOperation instanceof Taxon){
 328                         revealTaxon((Taxon) objectAffectedByOperation);
 329                 }
 330
 331                 return true;
 332         }
 333
 334
 335 }