-// $Id$\r
-/**\r
-* Copyright (C) 2007 EDIT\r
-* European Distributed Institute of Taxonomy \r
-* http://www.e-taxonomy.eu\r
-* \r
-* The contents of this file are subject to the Mozilla Public License Version 1.1\r
-* See LICENSE.TXT at the top of this package for the full license terms.\r
-*/\r
-package eu.etaxonomy.taxeditor.bulkeditor;\r
-\r
-import org.apache.log4j.Logger;\r
-import org.eclipse.jface.text.IDocument;\r
-import org.eclipse.jface.text.source.Annotation;\r
-import org.eclipse.jface.text.source.ISourceViewer;\r
-import org.eclipse.jface.text.source.IVerticalRuler;\r
-import org.eclipse.swt.SWT;\r
-import org.eclipse.swt.custom.StyledText;\r
-import org.eclipse.swt.events.MouseAdapter;\r
-import org.eclipse.swt.events.MouseEvent;\r
-import org.eclipse.swt.widgets.Composite;\r
-import org.eclipse.swt.widgets.Control;\r
-import org.eclipse.ui.IEditorInput;\r
-import org.eclipse.ui.IEditorSite;\r
-import org.eclipse.ui.PartInitException;\r
-import org.eclipse.ui.editors.text.TextEditor;\r
-\r
-/**\r
- * A document provider is responsible not just for providing the document for a \r
- * given editor input but for the complete translation between the domain model \r
- * and the editor's internal document-based model. Document provider can be shared \r
- * between editors. \r
- * \r
- * @author p.ciardelli\r
- * @created 25.06.2009\r
- * @version 1.0\r
- */\r
-public class BulkEditor extends TextEditor {\r
- @SuppressWarnings("unused")\r
- private static final Logger logger = Logger\r
- .getLogger(BulkEditor.class);\r
-\r
- public static final String ID = "bulkeditor.editor";\r
-\r
- private ISourceViewer viewer;\r
-\r
- public BulkEditor() {\r
- super();\r
- \r
- /**\r
- * see AbstractTextEditor javadoc for explanation of context menu ids\r
- */\r
- setEditorContextMenuId("#BulkEditorContext");\r
- }\r
- \r
- @Override\r
- public void init(IEditorSite site, IEditorInput input)\r
- throws PartInitException {\r
- LineEditorDocumentProvider provider = new LineEditorDocumentProvider();\r
- provider.setEntityCreator(new ReferenceCreator());\r
- setDocumentProvider(provider);\r
- super.init(site, input);\r
- }\r
- \r
- @Override\r
- protected ISourceViewer createSourceViewer(Composite parent,\r
- IVerticalRuler ruler, int styles) {\r
- fAnnotationAccess= getAnnotationAccess();\r
- fOverviewRuler= createOverviewRuler(getSharedColors()); \r
- viewer= new LineSelectionViewer(parent, ruler, getOverviewRuler(), \r
- isOverviewRulerVisible(), styles | SWT.WRAP);\r
- \r
- ((LineSelectionViewer) viewer).setLineSelectionSource(new LineSelectionSource(viewer));\r
- \r
- getSourceViewerDecorationSupport(viewer);\r
- setSourceViewerConfiguration(new BulkEditorSourceViewerConfiguration());\r
- \r
- addToggleMergeCandidateListener(ruler.getControl());\r
- return viewer;\r
- }\r
- \r
- private void addToggleMergeCandidateListener(Control control) {\r
- control.addMouseListener(new MouseAdapter() {\r
- @Override\r
- public void mouseDoubleClick(MouseEvent e) {\r
- StyledText textWidget = viewer.getTextWidget();\r
- int line = textWidget.getLineIndex(e.y);\r
- toggleMergeCandidateAnnotation(line);\r
- }\r
- });\r
- }\r
-\r
- private void toggleMergeCandidateAnnotation(int line) {\r
- IDocument document = viewer.getDocument();\r
- LineAnnotationModel model = \r
- (LineAnnotationModel) viewer.getAnnotationModel();\r
- \r
- Annotation annotation = model.getAnnotationAtLine(line, document);\r
- \r
- if (annotation != null) {\r
- if (annotation.getType().equals(IBulkEditorConstants.TYPE_MERGE_CANDIDATE)) {\r
- model.changeAnnotationType(\r
- annotation, LineAnnotation.TYPE_GENERIC);\r
- } else {\r
- model.changeAnnotationType(\r
- annotation, IBulkEditorConstants.TYPE_MERGE_CANDIDATE);\r
- }\r
- }\r
- }\r
-}
\ No newline at end of file
+// $Id$
+/**
+* Copyright (C) 2007 EDIT
+* European Distributed Institute of Taxonomy
+* http://www.e-taxonomy.eu
+*
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+
+package eu.etaxonomy.taxeditor.bulkeditor;
+
+import org.eclipse.jface.action.IMenuManager;
+import org.eclipse.jface.dialogs.MessageDialog;
+import org.eclipse.jface.dialogs.MessageDialogWithToggle;
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.source.Annotation;
+import org.eclipse.jface.text.source.AnnotationModel;
+import org.eclipse.jface.text.source.ISourceViewer;
+import org.eclipse.jface.text.source.IVerticalRuler;
+import org.eclipse.jface.util.IPropertyChangeListener;
+import org.eclipse.jface.window.Window;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.custom.StyledText;
+import org.eclipse.swt.events.MouseAdapter;
+import org.eclipse.swt.events.MouseEvent;
+import org.eclipse.swt.layout.GridData;
+import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorSite;
+import org.eclipse.ui.PartInitException;
+import org.eclipse.ui.texteditor.ITextEditorActionConstants;
+
+import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineDocumentProvider;
+import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineEditor;
+import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation;
+import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotationModel;
+import eu.etaxonomy.taxeditor.bulkeditor.input.AbstractBulkEditorInput;
+import eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider;
+import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;
+import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
+import eu.etaxonomy.taxeditor.store.CdmStore;
+
+/**
+ * <p>BulkEditor class.</p>
+ *
+ * @author p.ciardelli
+ * @created 07.07.2009
+ * @version 1.0
+ */
+public class BulkEditor extends AnnotatedLineEditor implements IPartContentHasDetails, IDirtyMarkableSelectionProvider{
+
+ /** Constant <code>ID="bulkeditor.editor"</code> */
+ public static final String ID = "bulkeditor.editor";
+
+ private boolean isInitialFocus = true;
+
+ private BulkEditorSearch searchBar = null;
+
+ private IPropertyChangeListener markerPreferenceListener;
+
+ /**
+ * <p>Constructor for BulkEditor.</p>
+ */
+ public BulkEditor() {
+ super(CdmStore.createConversation());
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.editors.text.TextEditor#initializeEditor()
+ */
+ /** {@inheritDoc} */
+ @Override
+ protected void initializeEditor() {
+ super.initializeEditor();
+
+ /**
+ * see AbstractTextEditor javadoc for explanation of context menu ids
+ */
+ setEditorContextMenuId("#BulkEditorContext");
+
+// setEntityCreatorService(new BulkEditorEntityCreatorService());
+
+ setLineDisplayStrategy(new BulkEditorLineDisplay(this));
+
+ setSourceViewerConfiguration(new BulkEditorViewerConfiguration(lineDisplayStrategy));
+ }
+
+ /* (non-Javadoc)
+ * @see eu.etaxonomy.taxeditor.bulkeditor.ListEditor#createSourceViewer(org.eclipse.swt.widgets.Composite, org.eclipse.jface.text.source.IVerticalRuler, int)
+ */
+ /** {@inheritDoc} */
+ protected ISourceViewer createSourceViewer(Composite parent,
+ IVerticalRuler ruler, int styles) {
+ ISourceViewer viewer = super.createSourceViewer(parent, ruler, styles);
+ if (((AbstractBulkEditorInput) getEditorInput()).isMergingEnabled()) {
+ addToggleMergeCandidateListener(ruler.getControl());
+ }
+ return viewer;
+ }
+
+ /* (non-Javadoc)
+ * @see eu.etaxonomy.taxeditor.bulkeditor.AnnotatedLineEditor#init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput)
+ */
+ /** {@inheritDoc} */
+ @Override
+ public void init(IEditorSite site, IEditorInput input)
+ throws PartInitException {
+
+ if (!(input instanceof AbstractBulkEditorInput)) {
+ throw new PartInitException("Invalid Input: Must be BulkEditorInput");
+ }
+
+ super.init(site, input);
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#createPartControl(org.eclipse.swt.widgets.Composite)
+ */
+ /** {@inheritDoc} */
+ @Override
+ public void createPartControl(Composite parent) {
+
+ parent.setLayout(new GridLayout());
+
+ Composite layoutComposite = new Composite(parent, SWT.NONE);
+ layoutComposite.setLayout(new GridLayout());
+
+ GridData gridData = new GridData(SWT.FILL, SWT.TOP, true, false);
+ layoutComposite.setLayoutData(gridData);
+
+// layoutComposite.setBackground(Display.getDefault().getSystemColor(SWT.COLOR_BLUE));
+
+
+ searchBar = new BulkEditorSearch(this, layoutComposite, SWT.NONE);
+// layoutComposite.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
+
+ super.createPartControl(parent);
+
+ // Set viewer composite to fill grid. Unfortunately it is private and we have to do a little hack here.
+ for (Control control : parent.getChildren()) {
+ if (control instanceof Composite &&
+ !(control.equals(layoutComposite))) {
+ control.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.editors.text.TextEditor#dispose()
+ */
+ /** {@inheritDoc} */
+ @Override
+ public void dispose() {
+ if (markerPreferenceListener != null ) {
+ PreferencesUtil.getPreferenceStore().removePropertyChangeListener(markerPreferenceListener);
+ }
+ super.dispose();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#isEditable()
+ */
+ /** {@inheritDoc} */
+ @Override
+ public boolean isEditable() {
+ return false;
+ }
+
+ /* (non-Javadoc)
+ * @see eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineEditor#setFocus()
+ */
+ /** {@inheritDoc} */
+ @Override
+ public void setFocus() {
+ searchBar.setFocus();
+
+ // TODO find a better place to put this - this dialog should be shown after initial contents of
+ // Editor are displayed
+ if (isInitialFocus) {
+ displayWarningDialog();
+ isInitialFocus = false;
+ }
+ }
+
+ /**
+ *
+ */
+ private void displayWarningDialog() {
+ IPreferenceStore prefs = PreferencesUtil.getPreferenceStore();
+ if (!prefs.getBoolean(PreferencesUtil.HIDE_BULKEDITOR_INFO)) {
+ String msg = "The Bulk Editor allows you to edit objects used to reference other objects, such as names, references, and authors.\n\n" +
+ "Any changes you make to an object in the Bulk Editor will be displayed wherever the object is used.\n\n" +
+ "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.";
+ MessageDialogWithToggle dialog = MessageDialogWithToggle.openOkCancelConfirm
+ (getSite().getShell(), "Bulk Editor", msg, "Do not show this message again",
+ false, null, PreferencesUtil.HIDE_BULKEDITOR_INFO);
+ if (dialog.getReturnCode() == Window.OK) {
+ prefs.setValue(PreferencesUtil.HIDE_BULKEDITOR_INFO, dialog.getToggleState());
+ }
+ }
+ }
+
+ /**
+ * @param control
+ */
+ private void addToggleMergeCandidateListener(Control control) {
+ control.addMouseListener(new MouseAdapter() {
+ @Override
+ public void mouseDoubleClick(MouseEvent e) {
+ StyledText textWidget = getSourceViewer().getTextWidget();
+ int line = textWidget.getLineIndex(e.y);
+ toggleMergeCandidateAnnotation(line);
+ }
+ });
+ }
+
+ /**
+ * <p>toggleMergeCandidateAnnotation</p>
+ *
+ * @param line a int.
+ */
+ public void toggleMergeCandidateAnnotation(int line) {
+
+ IDocument document = getSourceViewer().getDocument();
+ LineAnnotationModel model =
+ (LineAnnotationModel) getSourceViewer().getAnnotationModel();
+
+ if(model != null){
+ Annotation annotation = model.getAnnotationAtLine(line, document);
+
+ if (annotation != null) {
+ if (annotation.getType().equals(IBulkEditorConstants.TYPE_MERGE_CANDIDATE)) {
+ model.changeAnnotationType(
+ annotation, LineAnnotation.TYPE_GENERIC);
+ } else {
+ model.changeAnnotationType(
+ annotation, IBulkEditorConstants.TYPE_MERGE_CANDIDATE);
+ }
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ public void changed(Object object) {
+// this.dirty = dirty;
+ AnnotatedLineDocumentProvider p = (AnnotatedLineDocumentProvider) getDocumentProvider();
+ p.changed(object);
+// firePropertyChange(PROP_DIRTY);
+ }
+
+ /* (non-Javadoc)
+ * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
+ */
+ /** {@inheritDoc} */
+ public void performSearch(BulkEditorQuery query) {
+ if (query != null) {
+
+ // TODO check if dirty, prompt save
+ if (isDirty()) {
+ boolean proceed = MessageDialog.openQuestion(getEditorSite().getShell(),
+ "Save changes", "You have made changes that must be saved before this query can be executed. Would you like to proceed?");
+ if (proceed) {
+ doSave(null);
+ } else {
+ return;
+ }
+ }
+
+ getEditorInput().performSearch(query);
+
+ refresh();
+ }
+ }
+
+ /**
+ *
+ */
+ public void refresh() {
+ if(getDocumentProvider().getAnnotationModel(getEditorInput()) != null){
+ ((AnnotationModel) getDocumentProvider().getAnnotationModel(getEditorInput())).removeAllAnnotations();
+ }
+
+ setInput(getEditorInput());
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public AbstractBulkEditorInput getEditorInput() {
+ return (AbstractBulkEditorInput) super.getEditorInput();
+ }
+
+ protected void editorContextMenuAboutToShow(IMenuManager menu) {
+ super.editorContextMenuAboutToShow(menu);
+ menu.remove(ITextEditorActionConstants.SHIFT_RIGHT);
+ menu.remove(ITextEditorActionConstants.SHIFT_LEFT);
+ menu.remove(ITextEditorActionConstants.CONTEXT_PREFERENCES);
+ }
+}
BGBM BDI Projects / taxeditor.git / blobdiff