2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
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.
10 package eu
.etaxonomy
.taxeditor
.editor
.name
;
12 import java
.util
.ArrayList
;
13 import java
.util
.HashSet
;
14 import java
.util
.List
;
17 import org
.apache
.commons
.lang
.StringUtils
;
18 import org
.eclipse
.core
.commands
.operations
.IUndoContext
;
19 import org
.eclipse
.core
.runtime
.IAdaptable
;
20 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
21 import org
.eclipse
.core
.runtime
.OperationCanceledException
;
22 import org
.eclipse
.jface
.action
.MenuManager
;
23 import org
.eclipse
.jface
.viewers
.ISelection
;
24 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
25 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
26 import org
.eclipse
.swt
.SWT
;
27 import org
.eclipse
.swt
.dnd
.DND
;
28 import org
.eclipse
.swt
.dnd
.DropTarget
;
29 import org
.eclipse
.swt
.dnd
.Transfer
;
30 import org
.eclipse
.swt
.graphics
.Color
;
31 import org
.eclipse
.swt
.widgets
.Composite
;
32 import org
.eclipse
.swt
.widgets
.Display
;
33 import org
.eclipse
.swt
.widgets
.Menu
;
34 import org
.eclipse
.ui
.IEditorInput
;
35 import org
.eclipse
.ui
.IEditorSite
;
36 import org
.eclipse
.ui
.ISelectionListener
;
37 import org
.eclipse
.ui
.ISelectionService
;
38 import org
.eclipse
.ui
.IWorkbenchPart
;
39 import org
.eclipse
.ui
.IWorkbenchPartReference
;
40 import org
.eclipse
.ui
.PartInitException
;
41 import org
.eclipse
.ui
.forms
.ManagedForm
;
42 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
43 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
44 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
45 import org
.eclipse
.ui
.part
.EditorPart
;
47 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
48 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
49 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
50 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
51 import eu
.etaxonomy
.cdm
.model
.name
.HomotypicalGroup
;
52 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
53 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
54 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
55 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
56 import eu
.etaxonomy
.taxeditor
.editor
.CdmDataTransfer
;
57 import eu
.etaxonomy
.taxeditor
.editor
.EditorUtil
;
58 import eu
.etaxonomy
.taxeditor
.editor
.IDropTargetable
;
59 import eu
.etaxonomy
.taxeditor
.editor
.IMultiPageTaxonEditorPage
;
60 import eu
.etaxonomy
.taxeditor
.editor
.ISecuredEditor
;
61 import eu
.etaxonomy
.taxeditor
.editor
.MultiPageTaxonEditor
;
62 import eu
.etaxonomy
.taxeditor
.editor
.SimpleSelectionProvider
;
63 import eu
.etaxonomy
.taxeditor
.editor
.TaxonEditorInput
;
64 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AbstractGroup
;
65 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AbstractGroupedContainer
;
66 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AcceptedGroup
;
67 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AcceptedNameContainer
;
68 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.ContainerFactory
;
69 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.HomotypicalSynonymGroup
;
70 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.MisappliedGroup
;
71 import eu
.etaxonomy
.taxeditor
.editor
.name
.dnd
.NameEditorDropTargetListener
;
72 import eu
.etaxonomy
.taxeditor
.model
.IPartChangeListener
;
73 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasDetails
;
74 import eu
.etaxonomy
.taxeditor
.model
.TaxeditorPartService
;
75 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
76 import eu
.etaxonomy
.taxeditor
.preference
.Resources
;
77 import eu
.etaxonomy
.taxeditor
.security
.RequiredPermissions
;
78 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
79 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
83 * TaxonNameEditor class.
91 public class TaxonNameEditor
extends EditorPart
implements
92 IMultiPageTaxonEditorPage
, IAdaptable
, IConversationEnabled
,
93 IPostOperationEnabled
, IPartContentHasDetails
, IPartChangeListener
,
94 ISelectionListener
, IDropTargetable
, ISecuredEditor
{
96 /** Constant <code>ID="eu.etaxonomy.taxeditor.editor.taxon.name"</code> */
97 public static final String ID
= "eu.etaxonomy.taxeditor.editor.taxon.name";
101 private ManagedForm managedForm
;
102 private ScrolledForm scrolledForm
;
103 private Composite parent
;
104 private ISelectionProvider simpleSelectionProvider
;
106 private final MultiPageTaxonEditor editor
;
108 private TaxonBase selection
;
110 private final ConversationHolder conversation
;
112 private MenuManager menuManager
;
115 private AcceptedGroup acceptedGroup
;
116 private List
<HomotypicalSynonymGroup
> heterotypicSynonymGroups
= new ArrayList
<HomotypicalSynonymGroup
>();
117 private MisappliedGroup misappliedGroup
;
119 private DropTarget target
;
121 private ISelectionService selectionService
;
123 private TaxonBase objectAffectedByLastOperation
;
127 * Constructor for TaxonNameEditor.
131 * a {@link eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor}
134 public TaxonNameEditor(MultiPageTaxonEditor editor
) {
135 this.editor
= editor
;
136 conversation
= editor
.getConversationHolder();
144 * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
147 public IUndoContext
getUndoContext() {
148 return editor
.getUndoContext();
155 * org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets
160 public void createPartControl(Composite composite
) {
161 selectionService
= getSite().getWorkbenchWindow().getSelectionService();
162 selectionService
.addSelectionListener(this);
164 createManagedForm(composite
);
166 TaxeditorPartService
.getInstance().addListener(
167 TaxeditorPartService
.PART_ACTIVATED
, this);
176 * a {@link org.eclipse.swt.widgets.Composite} object.
178 protected void createManagedForm(Composite composite
) {
180 managedForm
= new ManagedForm(composite
) {
183 public void dirtyStateChanged() {
184 firePropertyChange(PROP_DIRTY
);
188 public boolean setInput(Object input
) {
189 if (input
instanceof AbstractGroupedContainer
) {
190 selection
= ((AbstractGroupedContainer
) input
).getData();
191 getSite().getSelectionProvider().setSelection(new StructuredSelection(selection
));
192 }else if(input
== null){
194 getSite().getSelectionProvider().setSelection(new StructuredSelection());
198 return super.setInput(input
);
202 scrolledForm
= managedForm
.getForm();
203 parent
= scrolledForm
.getBody();
205 // register the context menu
206 menuManager
= new MenuManager();
207 ISelectionProvider selectionProvider
= getSite().getSelectionProvider();
208 getSite().registerContextMenu(TaxonNameEditor
.ID
, menuManager
,
211 parent
.setData(taxon
);
213 TableWrapLayout layout
= new TableWrapLayout();
214 layout
.leftMargin
= 0;
215 layout
.rightMargin
= 0;
216 layout
.topMargin
= 0;
217 layout
.bottomMargin
= 0;
219 layout
.verticalSpacing
= 0;
220 layout
.horizontalSpacing
= 0;
222 parent
.setLayout(layout
);
223 parent
.setBackground(EditorUtil
224 .getColor(Resources
.COLOR_COMPOSITE_BACKGROUND
));
226 createOrUpdateNameComposites();
235 * createNameComposites
238 public void createOrUpdateNameComposites() {
240 ContainerFactory
.createOrUpdateAcceptedTaxonsHomotypicGroup(this);
241 ContainerFactory
.createOrUpdateHeterotypicSynonymyGroups(this);
242 ContainerFactory
.createOrUpdateMisapplicationsGroup(this);
245 managedForm
.reflow(true);
250 * Getter for the field <code>taxon</code>.
253 * @return a {@link eu.etaxonomy.cdm.model.taxon.Taxon} object.
255 public Taxon
getTaxon() {
256 return (Taxon
) HibernateProxyHelper
.deproxy(taxon
);
264 public void setDirty() {
265 managedForm
.dirtyStateChanged();
271 * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
275 public void setFocus() {
276 if (getSelectedContainer() == null) {
277 throw new IllegalStateException(
278 "There should always be a selected object.");
280 getSelectedContainer().setSelected();
283 boolean doEnable
= permissionsSatisfied();
284 setEnabled(doEnable
);
288 * @see eu.etaxonomy.taxeditor.editor.name.ISecuredEditorPart#permissionsSatisfied()
291 public boolean permissionsSatisfied() {
292 TaxonNode taxonNode
= ((TaxonEditorInput
)getEditorInput()).getTaxonNode();
293 boolean doEnable
= CdmStore
.currentAuthentiationHasPermission(taxonNode
, RequiredPermissions
.TAXONNODE_EDIT
);
299 public void setInput(IEditorInput input
) {
300 this.setInputWithNotify(input
);
307 * eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder
312 * getConversationHolder
315 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
318 public ConversationHolder
getConversationHolder() {
326 * eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu
327 * .etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
330 public void update(CdmDataChangeMap events
) {
335 * Redraws this editor return true on success
339 public boolean redraw() {
346 * Redraws the editor controls
348 public boolean redraw(boolean focus
) {
350 createOrUpdateNameComposites();
361 * getMultiPageTaxonEditor
364 * @return a {@link eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor}
367 public MultiPageTaxonEditor
getMultiPageTaxonEditor() {
375 * eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled#postOperation
379 public boolean postOperation(CdmBase objectAffectedByOperation
) {
381 editor
.changed(objectAffectedByOperation
);
385 if (objectAffectedByOperation
instanceof TaxonBase
) {
386 objectAffectedByLastOperation
= (TaxonBase
) objectAffectedByOperation
;
394 * Getter for the field <code>managedForm</code>.
397 * @return the managedForm
399 public ManagedForm
getManagedForm() {
408 * @return a {@link org.eclipse.swt.widgets.Composite} object.
410 public Composite
getControl() {
411 return this.getManagedForm().getForm().getBody();
416 * Getter for the field <code>menu</code>.
421 public Menu
getMenu() {
422 if (menu
== null || menu
.isDisposed()) {
423 // Creating the menu because it was either not initialised or
424 // disposed while refreshing the editor
425 menu
= menuManager
.createContextMenu(parent
);
435 * @return true if there are empty names
437 public boolean checkForEmptyNames() {
438 for (AbstractGroupedContainer container
: getGroupedContainers()) {
439 if (container
.getName() == null
440 || StringUtils
.isEmpty(container
.getName().getTitleCache())) {
447 public Set
<AbstractGroupedContainer
> getEmptyContainers() {
448 Set
<AbstractGroupedContainer
> containersWithEmptyNames
= new HashSet
<AbstractGroupedContainer
>();
450 for (AbstractGroupedContainer container
: getGroupedContainers()) {
451 if (container
.getName() == null
452 || StringUtils
.isEmpty(container
.getName().getTitleCache())) {
453 containersWithEmptyNames
.add(container
);
457 return containersWithEmptyNames
;
462 public void doSave(IProgressMonitor monitor
) {
464 monitor
.beginTask("Saving names", getGroupedContainers().size());
467 // check for empty names
468 for (AbstractGroupedContainer container
: getGroupedContainers()) {
470 monitor
.subTask("Saving composite: "
471 + container
.getTaxonBase().getTitleCache());
472 container
.persistName();
474 // In case the progress monitor was canceled throw an exception.
475 if (monitor
.isCanceled()) {
476 throw new OperationCanceledException();
479 // Otherwise declare this step as done.
484 // Stop the progress monitor.
492 public void doSaveAs() {
497 public void init(IEditorSite site
, IEditorInput input
)
498 throws PartInitException
{
500 if (!(input
instanceof IEditorInput
))
501 throw new PartInitException("Invalid Input: Must be IEditorInput");
503 if (input
.getAdapter(Taxon
.class) != null) {
504 taxon
= (Taxon
) input
.getAdapter(Taxon
.class);
506 throw new PartInitException("Invalid Input: Taxon cannot be null");
512 simpleSelectionProvider
= new SimpleSelectionProvider();
513 getSite().setSelectionProvider(simpleSelectionProvider
);
520 private void createDragSupport() {
521 // Listen for names being dragged outside of existing homotypic groups -
522 // user wants to create a new group
523 Transfer
[] types
= new Transfer
[] { CdmDataTransfer
.getInstance() };
524 int operations
= DND
.DROP_MOVE
;
525 if (target
== null) {
526 target
= new DropTarget(parent
, operations
);
527 target
.setTransfer(types
);
528 target
.addDropListener(new NameEditorDropTargetListener(this));
534 * Getter for the field <code>acceptedNameContainer</code>.
538 * {@link eu.etaxonomy.taxeditor.editor.name.container.AcceptedNameContainer}
541 public AcceptedNameContainer
getAcceptedNameContainer() {
542 return getAcceptedGroup().getAcceptedNameContainer();
550 * @param homotypicalGroup
551 * a {@link eu.etaxonomy.cdm.model.name.HomotypicalGroup} object.
553 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
556 public HomotypicalSynonymGroup
getHomotypicalGroupContainer(
557 HomotypicalGroup homotypicalGroup
) {
558 for (HomotypicalSynonymGroup group
: getHeterotypicSynonymGroups()) {
559 if (group
.getGroup().equals(homotypicalGroup
)) {
572 * @return a Set containing all composites that have been edited
574 public Set
<AbstractGroupedContainer
> getDirtyNames() {
575 Set
<AbstractGroupedContainer
> dirtyNames
= new HashSet
<AbstractGroupedContainer
>();
577 for (AbstractGroupedContainer composite
: getGroupedContainers()) {
578 if (composite
.isDirty()) {
579 dirtyNames
.add(composite
);
588 * getGroupedContainers
591 * @return a {@link java.util.List} object.
593 public List
<AbstractGroupedContainer
> getGroupedContainers() {
594 List
<AbstractGroupedContainer
> groupedComposites
= new ArrayList
<AbstractGroupedContainer
>();
596 for (AbstractGroup group
: getAllGroups()) {
597 groupedComposites
.addAll(group
.getGroupedContainers());
600 return groupedComposites
;
608 * @return a {@link java.util.List} object.
610 public List
<AbstractGroup
> getAllGroups() {
611 List
<AbstractGroup
> allGroups
= new ArrayList
<AbstractGroup
>();
613 allGroups
.add(getAcceptedGroup());
615 // List<HomotypicalSynonymGroup> grps = getHeterotypicSynonymGroups(); // UNUSED => remove
617 heterotypicSynonymGroups
= getHeterotypicSynonymGroups();
619 if (heterotypicSynonymGroups
!= null) {
620 allGroups
.addAll(heterotypicSynonymGroups
);
623 if (misappliedGroup
!= null) {
624 allGroups
.add(misappliedGroup
);
633 * @see org.eclipse.ui.part.EditorPart#isDirty()
637 public boolean isDirty() {
638 return editor
.isDirty();
644 * @see org.eclipse.ui.part.WorkbenchPart#dispose()
648 public void dispose() {
655 * @see org.eclipse.ui.part.EditorPart#isSaveAsAllowed()
659 public boolean isSaveAsAllowed() {
666 * @see org.eclipse.ui.ISelectionListener#selectionChanged(org.eclipse.ui.
667 * IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
670 public void selectionChanged(IWorkbenchPart part
, ISelection selection
) {
679 * @return a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor}
682 public TaxonNameEditor
getEditor() {
688 * Getter for the field <code>selectedObject</code>.
692 * {@link eu.etaxonomy.taxeditor.editor.name.container.AbstractGroupedContainer}
695 public AbstractGroupedContainer
getSelectedContainer() {
697 TaxonBase selectedTaxonBase
= null;
699 TaxonEditorInput input
= (TaxonEditorInput
) editor
.getEditorInput();
700 if (input
.getInitiallySelectedTaxonBase() != null) {
701 selectedTaxonBase
= input
.getInitiallySelectedTaxonBase();
703 if (selection
!= null) {
704 selectedTaxonBase
= selection
;
708 return (selectedTaxonBase
!= null) ?
getContainer(selectedTaxonBase
)
709 : getAcceptedNameContainer();
717 public void dragEntered() {
719 getControl().setBackground(
720 EditorUtil
.getColor(Resources
.COLOR_DRAG_ENTER
));
728 public void dragLeft() {
729 getControl().setBackground(
730 EditorUtil
.getColor(Resources
.COLOR_COMPOSITE_BACKGROUND
));
736 * setMisapplicationsGroup
739 * @param misappliedGroup
741 * {@link eu.etaxonomy.taxeditor.editor.name.container.MisappliedGroup}
744 public void setMisapplicationsGroup(MisappliedGroup misappliedGroup
) {
745 this.misappliedGroup
= misappliedGroup
;
752 * eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#isRedrawing()
761 public boolean isRedrawing() {
770 * @return a {@link org.eclipse.ui.forms.widgets.FormToolkit} object.
772 public FormToolkit
getToolkit() {
773 return managedForm
.getToolkit();
778 * getHeterotypicSynonymGroups
781 * @return a {@link java.util.List} object.
783 public List
<HomotypicalSynonymGroup
> getHeterotypicSynonymGroups() {
784 return heterotypicSynonymGroups
;
789 * addHeterotypicSynonymGroup
794 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
797 public void addHeterotypicSynonymGroup(HomotypicalSynonymGroup group
) {
798 heterotypicSynonymGroups
.add(group
);
803 * getHomotypicSynonymGroup
807 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
810 public AcceptedGroup
getAcceptedGroup() {
811 return acceptedGroup
;
816 * @param acceptedGroup
818 public void setAcceptedGroup(AcceptedGroup acceptedGroup
) {
819 this.acceptedGroup
= acceptedGroup
;
824 * Getter for the field <code>misappliedGroup</code>.
828 * {@link eu.etaxonomy.taxeditor.editor.name.container.MisappliedGroup}
831 public MisappliedGroup
getMisappliedGroup() {
832 return misappliedGroup
;
835 // TODO not very useful at the moment
843 public boolean isActive() {
844 IWorkbenchPart activePart
= EditorUtil
.getActivePart();
845 return editor
.equals(activePart
);
855 public boolean onComplete() {
856 getContainer(objectAffectedByLastOperation
).setSelected();
861 public void partChanged(Integer eventType
, IWorkbenchPartReference partRef
) {
862 if (!partRef
.getPart(false).equals(editor
)) {
863 // getSelectedObject().colorSelected(AbstractGroupedContainer.SELECTED_NO_FOCUS);
868 * @param retainedGroup
870 public void removeGroup(AbstractGroup group
) {
874 //if (heterotypicSynonymGroups != null) {
875 heterotypicSynonymGroups
.remove(group
);
884 public AbstractGroupedContainer
getContainer(TaxonBase taxonBase
) {
885 List
<AbstractGroupedContainer
> groupedContainers
= getGroupedContainers();
886 for (AbstractGroupedContainer container
: groupedContainers
) {
887 if (container
.getData().equals(taxonBase
)
888 && container
.getNameViewer().getTextWidget() != null) {
892 return getAcceptedNameContainer();
896 * @see eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#setOnError()
898 public void setOnError() {
899 Color disabledColor
= StoreUtil
.getColor(Resources
.COLOR_EDITOR_ERROR
);
900 setEnabled(false, disabledColor
);
904 * @see eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#setDisabled()
907 public void setDisabled(){
908 Color disabledColor
= StoreUtil
.getColor(Resources
.COLOR_TEXT_DISABLED_BACKGROUND
);
912 protected void setEnabled(boolean enabled
, Color background
) {
914 for(AbstractGroupedContainer groupedContainer
: getGroupedContainers()){
915 groupedContainer
.setEnabled(enabled
);
918 // send an empty selection to the current provider - TODO only on error ???
920 getManagedForm().setInput(null);
922 for (AbstractGroupedContainer groupedContainer
: getGroupedContainers()) {
923 groupedContainer
.setBackground(background
);
926 getControl().setBackground(background
);
930 public void setEnabled(boolean enabled
) {
931 Color background
= StoreUtil
.getColor(enabled ? Resources
.COLOR_COMPOSITE_BACKGROUND
: Resources
.COLOR_TEXT_DISABLED_BACKGROUND
);
932 setEnabled(enabled
, background
);