eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/bulkeditor/BulkEditor.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.bulkeditor;
  12
  13 import org.eclipse.core.runtime.IProgressMonitor;
  14 import org.eclipse.jface.action.IMenuManager;
  15 import org.eclipse.jface.dialogs.MessageDialog;
  16 import org.eclipse.jface.dialogs.MessageDialogWithToggle;
  17 import org.eclipse.jface.preference.IPreferenceStore;
  18 import org.eclipse.jface.text.IDocument;
  19 import org.eclipse.jface.text.ITextSelection;
  20 import org.eclipse.jface.text.TextSelection;
  21 import org.eclipse.jface.text.source.Annotation;
  22 import org.eclipse.jface.text.source.AnnotationModel;
  23 import org.eclipse.jface.text.source.ISourceViewer;
  24 import org.eclipse.jface.text.source.IVerticalRuler;
  25 import org.eclipse.jface.util.IPropertyChangeListener;
  26 import org.eclipse.jface.window.Window;
  27 import org.eclipse.swt.SWT;
  28 import org.eclipse.swt.custom.StyledText;
  29 import org.eclipse.swt.events.MouseAdapter;
  30 import org.eclipse.swt.events.MouseEvent;
  31 import org.eclipse.swt.layout.GridData;
  32 import org.eclipse.swt.layout.GridLayout;
  33 import org.eclipse.swt.widgets.Composite;
  34 import org.eclipse.swt.widgets.Control;
  35 import org.eclipse.ui.IEditorInput;
  36 import org.eclipse.ui.IEditorSite;
  37 import org.eclipse.ui.PartInitException;
  38 import org.eclipse.ui.texteditor.ITextEditorActionConstants;
  39
  40 import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineDocumentProvider;
  41 import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineEditor;
  42 import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation;
  43 import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotationModel;
  44 import eu.etaxonomy.taxeditor.bulkeditor.input.AbstractBulkEditorInput;
  45 import eu.etaxonomy.taxeditor.bulkeditor.input.TaxonEditorInput;
  46 import eu.etaxonomy.taxeditor.model.IDerivedUnitFacadePart;
  47 import eu.etaxonomy.taxeditor.model.IDirtyMarkable;
  48 import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;
  49 import eu.etaxonomy.taxeditor.model.IPartContentHasFactualData;
  50 import eu.etaxonomy.taxeditor.model.IPartContentHasMedia;
  51 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
  52 import eu.etaxonomy.taxeditor.store.CdmStore;
  53
  54 /**
  55  * @author p.ciardelli
  56  * @created 07.07.2009
  57  * @version 1.0
  58  */
  59 public class BulkEditor extends AnnotatedLineEditor implements IPartContentHasDetails,
  60         IDirtyMarkable, IDerivedUnitFacadePart, IPartContentHasFactualData, IPartContentHasMedia {
  61
  62         /** Constant <code>ID="bulkeditor.editor"</code> */
  63         public static final String ID = "bulkeditor.editor";
  64
  65         private boolean isInitialFocus = true;
  66
  67         private BulkEditorSearch searchBar = null;
  68
  69         private IPropertyChangeListener markerPreferenceListener;
  70
  71         private boolean isDirty;
  72
  73         public BulkEditor() {
  74                 super(CdmStore.createConversation());
  75         }
  76
  77         /** {@inheritDoc} */
  78         @Override
  79         protected void initializeEditor() {
  80                 super.initializeEditor();
  81
  82                 /**
  83                  * see AbstractTextEditor javadoc for explanation of context menu ids
  84                  */
  85                 setEditorContextMenuId("#BulkEditorContext");
  86
  87 //              setEntityCreatorService(new BulkEditorEntityCreatorService());
  88
  89                 setLineDisplayStrategy(new BulkEditorLineDisplay(this));
  90
  91                 setSourceViewerConfiguration(new BulkEditorViewerConfiguration(lineDisplayStrategy));
  92         }
  93
  94         /** {@inheritDoc} */
  95         @Override
  96     protected ISourceViewer createSourceViewer(Composite parent,
  97                         IVerticalRuler ruler, int styles) {
  98                 ISourceViewer viewer = super.createSourceViewer(parent, ruler, styles);
  99                 if (getEditorInput().isMergingEnabled()) {
 100                         addToggleMergeCandidateListener(ruler.getControl());
 101                 }
 102                 return viewer;
 103         }
 104
 105         /** {@inheritDoc} */
 106         @Override
 107         public void init(IEditorSite site, IEditorInput input)
 108                         throws PartInitException {
 109
 110                 if (!(input instanceof AbstractBulkEditorInput)) {
 111                         throw new PartInitException("Invalid Input: Must be BulkEditorInput");
 112                 }
 113
 114                 super.init(site, input);
 115         }
 116
 117         /** {@inheritDoc} */
 118         @Override
 119         public void createPartControl(Composite parent) {
 120
 121                 parent.setLayout(new GridLayout());
 122
 123                 Composite layoutComposite = new Composite(parent, SWT.NONE);
 124                 layoutComposite.setLayout(new GridLayout());
 125
 126                 GridData gridData = new GridData(SWT.FILL, SWT.TOP, true, false);
 127                 layoutComposite.setLayoutData(gridData);
 128
 129 //              layoutComposite.setBackground(Display.getDefault().getSystemColor(SWT.COLOR_BLUE));
 130
 131
 132                 searchBar = new BulkEditorSearch(this, layoutComposite, SWT.NONE);
 133 //              layoutComposite.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
 134
 135                 super.createPartControl(parent);
 136
 137                 // Set viewer composite to fill grid. Unfortunately it is private and we have to do a little hack here.
 138                 for (Control control : parent.getChildren()) {
 139                         if (control instanceof Composite &&
 140                                                 !(control.equals(layoutComposite))) {
 141                                 control.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 142                         }
 143                 }
 144         }
 145
 146         /** {@inheritDoc} */
 147         @Override
 148         public void dispose() {
 149                 if (markerPreferenceListener != null ) {
 150                         PreferencesUtil.getPreferenceStore().removePropertyChangeListener(markerPreferenceListener);
 151                 }
 152                 super.dispose();
 153         }
 154
 155
 156         /** {@inheritDoc} */
 157         @Override
 158         public boolean isEditable() {
 159                 return false;
 160         }
 161
 162         /** {@inheritDoc} */
 163         @Override
 164         public void setFocus() {
 165             conversation.bind();
 166                 searchBar.setFocus();
 167
 168                 // TODO find a better place to put this - this dialog should be shown after initial contents of
 169                 //      Editor are displayed
 170                 if (isInitialFocus) {
 171                         displayWarningDialog();
 172                         isInitialFocus = false;
 173                 }
 174         }
 175
 176         private void displayWarningDialog() {
 177                 IPreferenceStore prefs = PreferencesUtil.getPreferenceStore();
 178                 if (!prefs.getBoolean(PreferencesUtil.HIDE_BULKEDITOR_INFO)) {
 179                         String msg = "The Bulk Editor allows you to edit objects used to reference other objects, such as names, references, and authors.\n\n" +
 180                                                         "Any changes you make to an object in the Bulk Editor will be displayed wherever the object is used.\n\n" +
 181                                                         "For instance, a reference may be displayed with both a name and a descriptive element. If the reference name is changed here, the display of both the name and the descriptive element will be affected.";
 182                         MessageDialogWithToggle dialog = MessageDialogWithToggle.openOkCancelConfirm
 183                                                                                                 (getSite().getShell(), "Bulk Editor", msg, "Do not show this message again",
 184                                                                                                                 false, null, PreferencesUtil.HIDE_BULKEDITOR_INFO);
 185                         if (dialog.getReturnCode() == Window.OK) {
 186                                 prefs.setValue(PreferencesUtil.HIDE_BULKEDITOR_INFO, dialog.getToggleState());
 187                         }
 188                 }
 189         }
 190
 191         private void addToggleMergeCandidateListener(Control control) {
 192                 control.addMouseListener(new MouseAdapter() {
 193                         @Override
 194                         public void mouseDoubleClick(MouseEvent e) {
 195                                 StyledText textWidget = getSourceViewer().getTextWidget();
 196                                 int line = textWidget.getLineIndex(e.y);
 197                                 toggleMergeCandidateAnnotation(line);
 198                         }
 199                 });
 200         }
 201
 202         public void toggleMergeCandidateAnnotation(int line) {
 203
 204                 IDocument document = getSourceViewer().getDocument();
 205                 LineAnnotationModel model =
 206                                 (LineAnnotationModel) getSourceViewer().getAnnotationModel();
 207
 208                 if(model != null){
 209                         Annotation annotation = model.getAnnotationAtLine(line, document);
 210
 211                         if (annotation != null) {
 212                                 if (annotation.getType().equals(IBulkEditorConstants.TYPE_MERGE_CANDIDATE)) {
 213                                         model.changeAnnotationType(
 214                                                         annotation, LineAnnotation.TYPE_GENERIC);
 215                                 } else {
 216                                         model.changeAnnotationType(
 217                                                         annotation, IBulkEditorConstants.TYPE_MERGE_CANDIDATE);
 218                                 }
 219                         }
 220                 }
 221         }
 222
 223         @Override
 224         public boolean isDirty() {
 225             if(isDirty){
 226                 return isDirty;
 227             }
 228             else{
 229                 return super.isDirty();
 230             }
 231         }
 232
 233         @Override
 234     public void forceDirty(){
 235             isDirty = true;
 236             firePropertyChange(PROP_DIRTY);
 237         }
 238
 239         @Override
 240         public void doSave(IProgressMonitor progressMonitor) {
 241             isDirty = false;
 242
 243             super.doSave(progressMonitor);
 244
 245             selectFirstItem();
 246
 247                 getSourceViewer().getTextWidget().setFocus();
 248
 249         }
 250
 251         /** {@inheritDoc} */
 252         @Override
 253     public void changed(Object object) {
 254 //              this.dirty = dirty;
 255                 AnnotatedLineDocumentProvider p = (AnnotatedLineDocumentProvider) getDocumentProvider();
 256                 p.changed(object);
 257 //              firePropertyChange(PROP_DIRTY);
 258         }
 259
 260         /** {@inheritDoc} */
 261         public void performSearch(BulkEditorQuery query) {
 262                 if (query != null) {
 263
 264                         // TODO check if dirty, prompt save
 265                         if (isDirty()) {
 266                                 boolean proceed = MessageDialog.openQuestion(getEditorSite().getShell(),
 267                                                 "Save changes", "You have made changes that must be saved before this query can be executed. Would you like to proceed?");
 268                                 if (proceed) {
 269                                         doSave(null);
 270                                 } else {
 271                                         return;
 272                                 }
 273                         }
 274                         conversation.commit();
 275                         conversation.clear();
 276
 277                         getEditorInput().performSearch(query);
 278
 279                         refresh();
 280
 281                         selectFirstItem();
 282
 283                         getSourceViewer().getTextWidget().setFocus();
 284                 }
 285         }
 286
 287         private void selectFirstItem() {
 288                 ITextSelection selection = new TextSelection(0, 0);
 289                 getSelectionProvider().setSelection(selection);
 290         }
 291
 292         public void refresh() {
 293                 if(getDocumentProvider().getAnnotationModel(getEditorInput()) != null){
 294                         ((AnnotationModel) getDocumentProvider().getAnnotationModel(getEditorInput())).removeAllAnnotations();
 295                 }
 296
 297                 setInput(getEditorInput());
 298         }
 299
 300         /** {@inheritDoc} */
 301         @Override
 302         public AbstractBulkEditorInput getEditorInput() {
 303                 return (AbstractBulkEditorInput) super.getEditorInput();
 304         }
 305
 306         @Override
 307     protected void editorContextMenuAboutToShow(IMenuManager menu) {
 308                 super.editorContextMenuAboutToShow(menu);
 309                 menu.remove(ITextEditorActionConstants.SHIFT_RIGHT);
 310                 menu.remove(ITextEditorActionConstants.SHIFT_LEFT);
 311                 menu.remove(ITextEditorActionConstants.CONTEXT_PREFERENCES);
 312         }
 313
 314         @Override
 315         public boolean canAttachMedia() {
 316             return getEditorInput() instanceof TaxonEditorInput?true:false;
 317         }
 318 }