eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/editor/definedterm/DefinedTermEditor.java

   1 // $Id$
   2 /**
   3  * Copyright (C) 2009 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.definedterm;
  11
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16
  17 import org.eclipse.core.runtime.IProgressMonitor;
  18 import org.eclipse.jface.action.GroupMarker;
  19 import org.eclipse.jface.action.MenuManager;
  20 import org.eclipse.jface.viewers.ISelection;
  21 import org.eclipse.jface.viewers.StructuredSelection;
  22 import org.eclipse.jface.viewers.TreeViewer;
  23 import org.eclipse.jface.viewers.Viewer;
  24 import org.eclipse.jface.viewers.ViewerSorter;
  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.layout.FillLayout;
  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.ui.IEditorInput;
  33 import org.eclipse.ui.IEditorSite;
  34 import org.eclipse.ui.ISelectionListener;
  35 import org.eclipse.ui.ISelectionService;
  36 import org.eclipse.ui.IWorkbenchActionConstants;
  37 import org.eclipse.ui.IWorkbenchPart;
  38 import org.eclipse.ui.PartInitException;
  39 import org.eclipse.ui.part.EditorPart;
  40
  41 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  42 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  43 import eu.etaxonomy.cdm.api.service.IVocabularyService;
  44 import eu.etaxonomy.cdm.model.common.CdmBase;
  45 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
  46 import eu.etaxonomy.cdm.model.common.OrderedTermBase;
  47 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  48 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  49 import eu.etaxonomy.taxeditor.editor.definedterm.input.TermEditorInput;
  50 import eu.etaxonomy.taxeditor.model.IDirtyMarkable;
  51 import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;
  52 import eu.etaxonomy.taxeditor.session.ICdmEntitySession;
  53 import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;
  54 import eu.etaxonomy.taxeditor.store.CdmStore;
  55 import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;
  56
  57 /**
  58  * @author l.morris
  59  * @date 3 Jan 2012
  60  *
  61  */
  62 public class DefinedTermEditor extends EditorPart implements IConversationEnabled, ISelectionListener, IDirtyMarkable, IPostOperationEnabled, ICdmEntitySessionEnabled {
  63
  64         public static final String ID = "eu.etaxonomy.taxeditor.editor.definedTerm";
  65
  66         public static final String OPEN_COMMAND_ID = "eu.etaxonomy.taxeditor.store.openDefinedTermEditor";
  67
  68         protected TreeViewer viewer;
  69         protected ConversationHolder conversation;
  70         private ISelectionService selectionService;
  71         private boolean dirty;
  72
  73         private final ICdmEntitySession cdmEntitySession;
  74
  75
  76         private final int dndOperations = DND.DROP_COPY | DND.DROP_MOVE;
  77         /**
  78          *
  79          */
  80         public DefinedTermEditor() {
  81                 super();
  82                 conversation = CdmStore.createConversation();
  83                 cdmEntitySession = CdmStore.getCurrentSessionManager().newSession(this, true);
  84         }
  85
  86         @Override
  87         public void createPartControl(Composite parent) {
  88
  89         //              parent.setBackground(Display.getDefault().getSystemColor(SWT.COLOR_BLUE));
  90
  91                         FillLayout layout = new FillLayout();
  92                         layout.marginHeight = 0;
  93                         layout.marginWidth = 0;
  94                         layout.type = SWT.VERTICAL;
  95
  96                         parent.setLayout(layout);
  97                         viewer = new TreeViewer(parent);
  98                         viewer.getControl().setLayoutData(LayoutConstants.FILL());
  99                         viewer.setContentProvider(new TermContentProvider());
 100                         viewer.setLabelProvider(new TermLabelProvider());
 101                         viewer.setSorter(new DefinedTermSorter());
 102
 103                         Transfer[] transfers = new Transfer[] { TermTransfer.getInstance() };
 104                         viewer.addDragSupport(dndOperations, transfers, new DefinedTermDragListener(viewer));
 105                         viewer.addDropSupport(dndOperations, transfers, new DefinedTermDropAdapter(this));
 106
 107                         getDefinedTermEditorInput().initialiseVocabularies();
 108                         viewer.setInput(getDefinedTermEditorInput().getVocabularies());
 109
 110                         getSite().setSelectionProvider(viewer);
 111
 112                         selectionService = getSite().getWorkbenchWindow().getSelectionService();
 113                         selectionService.addSelectionListener(this);
 114
 115                         setPartName(getEditorInput().getName());
 116                         createMenu();
 117                 }
 118
 119
 120
 121
 122         /**
 123          *
 124          */
 125         public TermEditorInput getDefinedTermEditorInput() {
 126                 return (TermEditorInput) getEditorInput();
 127         }
 128
 129         /* (non-Javadoc)
 130          * @see eu.etaxonomy.taxeditor.operation.IPostOperationEnabled#postOperation(eu.etaxonomy.cdm.model.common.CdmBase)
 131          */
 132         @Override
 133         public boolean postOperation(CdmBase objectAffectedByOperation) {
 134
 135
 136                 viewer.refresh();
 137
 138                 if(objectAffectedByOperation != null){
 139                         viewer.setSelection(new StructuredSelection(objectAffectedByOperation));
 140                 }
 141                 setDirty(true);
 142
 143                 return true;
 144         }
 145
 146         private void createMenu() {
 147                 // register context menu
 148                 MenuManager menuManager = new MenuManager();
 149                 menuManager
 150                                 .add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));
 151                 getSite().registerContextMenu(ID, menuManager, viewer);
 152
 153                 Control control = viewer.getControl();
 154                 Menu menu = menuManager.createContextMenu(control);
 155                 control.setMenu(menu);
 156         }
 157
 158
 159
 160
 161         @Override
 162         public void doSave(IProgressMonitor monitor) {
 163                 getConversationHolder().commit();
 164                 CdmStore.getService(IVocabularyService.class).merge(new ArrayList<TermVocabulary>(getRootEntities()));
 165                 setDirty(false);
 166                 getDefinedTermEditorInput().initialiseVocabularies();
 167                 viewer.refresh();
 168         }
 169
 170
 171         @Override
 172         public void doSaveAs() {}
 173
 174         @Override
 175         public void init(IEditorSite site, IEditorInput input) throws PartInitException {
 176                 setSite(site);
 177                 setInput(input);
 178
 179         }
 180
 181         @Override
 182         public boolean isDirty() {
 183                 return dirty;
 184         }
 185
 186         @Override
 187         public boolean isSaveAsAllowed() {
 188                 return false;
 189         }
 190
 191         @Override
 192         public void setFocus() {
 193             viewer.getControl().setFocus();
 194                 getConversationHolder().bind();
 195                 cdmEntitySession.bind();
 196         }
 197
 198         @Override
 199         public void update(CdmDataChangeMap changeEvents) {
 200                 // TODO Auto-generated method stub
 201
 202         }
 203
 204         @Override
 205         public ConversationHolder getConversationHolder() {
 206                 return conversation;
 207         }
 208
 209         @Override
 210         public void selectionChanged(IWorkbenchPart part, ISelection selection) {
 211                 // TODO Auto-generated method stub
 212
 213         }
 214
 215         @Override
 216         public void changed(Object element) {
 217                 dirty = true;
 218                 setDirty(true);
 219                 viewer.update(element, null);
 220         }
 221
 222         /* (non-Javadoc)
 223          * @see eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider#forceDirty()
 224          */
 225         @Override
 226         public void forceDirty() {
 227             changed(null);
 228         }
 229
 230         /**
 231          * @param dirty the dirty to set
 232          */
 233         public void setDirty(boolean dirty) {
 234                 this.dirty = dirty;
 235                 firePropertyChange(PROP_DIRTY);
 236         }
 237
 238         @Override
 239         public boolean onComplete() {
 240                 // TODO Auto-generated method stub
 241                 return false;
 242         }
 243
 244         /**
 245          *
 246          */
 247         public TreeViewer getViewer() {
 248                 return viewer;
 249         }
 250
 251         private class DefinedTermSorter extends ViewerSorter {
 252
 253             @Override
 254             public int compare(Viewer viewer, Object e1, Object e2) {
 255                 // the comparison value in this method determines the
 256                 // location <-> add term method used in the MoveDefinedTermOperation
 257                 // execute call
 258                 if(e1 instanceof OrderedTermBase && e2 instanceof OrderedTermBase) {
 259                     OrderedTermBase otbe1 = (OrderedTermBase)e1;
 260                     OrderedTermBase otbe2 = (OrderedTermBase)e2;
 261                     if(otbe1.getOrderIndex() == otbe2.getOrderIndex()) {
 262                         return 0;
 263                     } else if(otbe1.isHigher(otbe2)) {
 264                         return 1;
 265                     } else {
 266                         return -1;
 267                     }
 268                 } else {
 269                     return super.compare(viewer, e1, e2);
 270                 }
 271             }
 272         }
 273
 274         @Override
 275         public void dispose() {
 276             cdmEntitySession.dispose();
 277             super.dispose();
 278         }
 279
 280     /* (non-Javadoc)
 281      * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getCdmEntitySession()
 282      */
 283     @Override
 284     public ICdmEntitySession getCdmEntitySession() {
 285         return cdmEntitySession;
 286     }
 287
 288     /* (non-Javadoc)
 289      * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getRootEntities()
 290      */
 291     @Override
 292     public Set<TermVocabulary<DefinedTermBase>> getRootEntities() {
 293         return getDefinedTermEditorInput().getVocabularies();
 294     }
 295
 296     /* (non-Javadoc)
 297      * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getPropertyPathsMap()
 298      */
 299     @Override
 300     public Map<Object, List<String>> getPropertyPathsMap() {
 301         // TODO Auto-generated method stub
 302         return null;
 303     }
 304
 305
 306 }