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
.IProgressMonitor
;
20 import org
.eclipse
.core
.runtime
.OperationCanceledException
;
21 import org
.eclipse
.jface
.action
.MenuManager
;
22 import org
.eclipse
.jface
.viewers
.ISelection
;
23 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
24 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
25 import org
.eclipse
.swt
.dnd
.DND
;
26 import org
.eclipse
.swt
.dnd
.DropTarget
;
27 import org
.eclipse
.swt
.dnd
.Transfer
;
28 import org
.eclipse
.swt
.graphics
.Color
;
29 import org
.eclipse
.swt
.widgets
.Composite
;
30 import org
.eclipse
.swt
.widgets
.Menu
;
31 import org
.eclipse
.ui
.IEditorInput
;
32 import org
.eclipse
.ui
.IEditorSite
;
33 import org
.eclipse
.ui
.ISelectionListener
;
34 import org
.eclipse
.ui
.ISelectionService
;
35 import org
.eclipse
.ui
.IWorkbenchPart
;
36 import org
.eclipse
.ui
.IWorkbenchPartReference
;
37 import org
.eclipse
.ui
.PartInitException
;
38 import org
.eclipse
.ui
.PlatformUI
;
39 import org
.eclipse
.ui
.forms
.ManagedForm
;
40 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
41 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
42 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
43 import org
.eclipse
.ui
.part
.EditorPart
;
45 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
46 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
47 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonService
;
48 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
49 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
50 import eu
.etaxonomy
.cdm
.model
.name
.HomotypicalGroup
;
51 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
52 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
53 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
54 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
55 import eu
.etaxonomy
.taxeditor
.editor
.CdmDataTransfer
;
56 import eu
.etaxonomy
.taxeditor
.editor
.EditorUtil
;
57 import eu
.etaxonomy
.taxeditor
.editor
.IDropTargetable
;
58 import eu
.etaxonomy
.taxeditor
.editor
.IMultiPageTaxonEditorPage
;
59 import eu
.etaxonomy
.taxeditor
.editor
.ISecuredEditor
;
60 import eu
.etaxonomy
.taxeditor
.editor
.MultiPageTaxonEditor
;
61 import eu
.etaxonomy
.taxeditor
.editor
.SimpleSelectionProvider
;
62 import eu
.etaxonomy
.taxeditor
.editor
.TaxonEditorInput
;
63 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AbstractGroup
;
64 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AbstractGroupedContainer
;
65 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AcceptedGroup
;
66 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.AcceptedNameContainer
;
67 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.ContainerFactory
;
68 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.HomotypicalSynonymGroup
;
69 import eu
.etaxonomy
.taxeditor
.editor
.name
.container
.MisappliedGroup
;
70 import eu
.etaxonomy
.taxeditor
.editor
.name
.dnd
.NameEditorDropTargetListener
;
71 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
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
.preference
.Resources
;
76 import eu
.etaxonomy
.taxeditor
.security
.RequiredPermissions
;
77 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
78 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
82 * TaxonNameEditor class.
90 public class TaxonNameEditor
extends EditorPart
implements
91 IMultiPageTaxonEditorPage
, IConversationEnabled
,
92 IPartContentHasDetails
, IPartChangeListener
,
93 ISelectionListener
, IDropTargetable
, ISecuredEditor
{
95 /** Constant <code>ID="eu.etaxonomy.taxeditor.editor.taxon.name"</code> */
96 public static final String ID
= "eu.etaxonomy.taxeditor.editor.taxon.name";
100 private ManagedForm managedForm
;
101 private ScrolledForm scrolledForm
;
102 private Composite parent
;
103 private ISelectionProvider simpleSelectionProvider
;
105 private final MultiPageTaxonEditor editor
;
107 private TaxonBase selection
;
109 private final ConversationHolder conversation
;
111 private MenuManager menuManager
;
114 private AcceptedGroup acceptedGroup
;
115 private List
<HomotypicalSynonymGroup
> heterotypicSynonymGroups
= new ArrayList
<HomotypicalSynonymGroup
>();
116 private MisappliedGroup misappliedGroup
;
118 private DropTarget target
;
120 private ISelectionService selectionService
;
122 private TaxonBase objectAffectedByLastOperation
;
126 * Constructor for TaxonNameEditor.
130 * a {@link eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor}
133 public TaxonNameEditor(MultiPageTaxonEditor editor
) {
134 this.editor
= editor
;
135 conversation
= editor
.getConversationHolder();
143 * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
146 public IUndoContext
getUndoContext() {
147 return editor
.getUndoContext();
154 * org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets
159 public void createPartControl(Composite composite
) {
160 selectionService
= getSite().getWorkbenchWindow().getSelectionService();
161 selectionService
.addSelectionListener(this);
163 createManagedForm(composite
);
165 TaxeditorPartService
.getInstance().addListener(
166 TaxeditorPartService
.PART_ACTIVATED
, this);
175 * a {@link org.eclipse.swt.widgets.Composite} object.
177 protected void createManagedForm(Composite composite
) {
179 managedForm
= new ManagedForm(composite
) {
182 public void dirtyStateChanged() {
183 firePropertyChange(PROP_DIRTY
);
187 public boolean setInput(Object input
) {
188 if (input
instanceof AbstractGroupedContainer
) {
189 selection
= ((AbstractGroupedContainer
) input
).getData();
190 getSite().getSelectionProvider().setSelection(new StructuredSelection(selection
));
191 }else if(input
== null){
193 getSite().getSelectionProvider().setSelection(new StructuredSelection());
197 return super.setInput(input
);
201 scrolledForm
= managedForm
.getForm();
202 parent
= scrolledForm
.getBody();
204 // register the context menu
205 menuManager
= new MenuManager();
206 ISelectionProvider selectionProvider
= getSite().getSelectionProvider();
207 getSite().registerContextMenu(TaxonNameEditor
.ID
, menuManager
,
210 parent
.setData(taxon
);
212 TableWrapLayout layout
= new TableWrapLayout();
213 layout
.leftMargin
= 0;
214 layout
.rightMargin
= 0;
215 layout
.topMargin
= 0;
216 layout
.bottomMargin
= 0;
218 layout
.verticalSpacing
= 0;
219 layout
.horizontalSpacing
= 0;
221 parent
.setLayout(layout
);
222 parent
.setBackground(AbstractUtility
223 .getColor(Resources
.COLOR_COMPOSITE_BACKGROUND
));
225 createOrUpdateNameComposites();
234 * createNameComposites
237 public void createOrUpdateNameComposites() {
238 //this.taxon = (Taxon)CdmStore.getService(ITaxonService.class).load(this.getTaxon().getUuid());
239 //this.taxon = HibernateProxyHelper.deproxy(this.taxon, Taxon.class);
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 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell().setFocus();
277 if (getSelectedContainer() == null) {
278 throw new IllegalStateException(
279 "There should always be a selected object.");
281 getSelectedContainer().setSelected();
284 boolean doEnable
= permissionsSatisfied();
285 setEnabled(doEnable
);
289 * @see eu.etaxonomy.taxeditor.editor.name.ISecuredEditorPart#permissionsSatisfied()
292 public boolean permissionsSatisfied() {
293 TaxonNode taxonNode
= ((TaxonEditorInput
)getEditorInput()).getTaxonNode();
294 boolean doEnable
= CdmStore
.currentAuthentiationHasPermission(taxonNode
, RequiredPermissions
.TAXONNODE_EDIT
);
300 public void setInput(IEditorInput input
) {
301 this.setInputWithNotify(input
);
308 * eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder
313 * getConversationHolder
316 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
320 public ConversationHolder
getConversationHolder() {
328 * eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu
329 * .etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
333 public void update(CdmDataChangeMap events
) {
338 * Redraws this editor return true on success
343 public boolean redraw() {
350 * Redraws the editor controls
353 public boolean redraw(boolean focus
) {
355 createOrUpdateNameComposites();
366 * getMultiPageTaxonEditor
369 * @return a {@link eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor}
372 public MultiPageTaxonEditor
getMultiPageTaxonEditor() {
380 * eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled#postOperation
385 public boolean postOperation(CdmBase objectAffectedByOperation
) {
387 editor
.changed(objectAffectedByOperation
);
391 if (objectAffectedByOperation
instanceof TaxonBase
) {
392 objectAffectedByLastOperation
= (TaxonBase
) objectAffectedByOperation
;
400 * Getter for the field <code>managedForm</code>.
403 * @return the managedForm
405 public ManagedForm
getManagedForm() {
414 * @return a {@link org.eclipse.swt.widgets.Composite} object.
417 public Composite
getControl() {
418 return this.getManagedForm().getForm().getBody();
423 * Getter for the field <code>menu</code>.
428 public Menu
getMenu() {
429 if (menu
== null || menu
.isDisposed()) {
430 // Creating the menu because it was either not initialised or
431 // disposed while refreshing the editor
432 menu
= menuManager
.createContextMenu(parent
);
442 * @return true if there are empty names
444 public boolean checkForEmptyNames() {
445 for (AbstractGroupedContainer container
: getGroupedContainers()) {
446 if (container
.getName() == null
447 || StringUtils
.isEmpty(container
.getName().getTitleCache())) {
454 public Set
<AbstractGroupedContainer
> getEmptyContainers() {
455 Set
<AbstractGroupedContainer
> containersWithEmptyNames
= new HashSet
<AbstractGroupedContainer
>();
457 for (AbstractGroupedContainer container
: getGroupedContainers()) {
458 if (container
.getName() == null
459 || StringUtils
.isEmpty(container
.getName().getTitleCache())) {
460 containersWithEmptyNames
.add(container
);
464 return containersWithEmptyNames
;
469 public void doSave(IProgressMonitor monitor
) {
471 monitor
.beginTask("Saving names", getGroupedContainers().size());
474 // check for empty names
475 for (AbstractGroupedContainer container
: getGroupedContainers()) {
477 monitor
.subTask("Saving composite: "
478 + container
.getTaxonBase().getTitleCache());
479 container
.persistName();
481 // In case the progress monitor was canceled throw an exception.
482 if (monitor
.isCanceled()) {
483 throw new OperationCanceledException();
486 // Otherwise declare this step as done.
491 // Stop the progress monitor.
499 public void doSaveAs() {
504 public void init(IEditorSite site
, IEditorInput input
)
505 throws PartInitException
{
507 if (!(input
!= null)) {
508 throw new PartInitException("Invalid Input: Must be IEditorInput");
511 if (input
.getAdapter(Taxon
.class) != null) {
512 taxon
= (Taxon
) input
.getAdapter(Taxon
.class);
514 throw new PartInitException("Invalid Input: Taxon cannot be null");
520 simpleSelectionProvider
= new SimpleSelectionProvider();
521 getSite().setSelectionProvider(simpleSelectionProvider
);
528 private void createDragSupport() {
529 // Listen for names being dragged outside of existing homotypic groups -
530 // user wants to create a new group
531 Transfer
[] types
= new Transfer
[] { CdmDataTransfer
.getInstance() };
532 int operations
= DND
.DROP_MOVE
;
533 if (target
== null) {
534 target
= new DropTarget(parent
, operations
);
535 target
.setTransfer(types
);
536 target
.addDropListener(new NameEditorDropTargetListener(this));
542 * Getter for the field <code>acceptedNameContainer</code>.
546 * {@link eu.etaxonomy.taxeditor.editor.name.container.AcceptedNameContainer}
549 public AcceptedNameContainer
getAcceptedNameContainer() {
550 return getAcceptedGroup().getAcceptedNameContainer();
558 * @param homotypicalGroup
559 * a {@link eu.etaxonomy.cdm.model.name.HomotypicalGroup} object.
561 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
564 public HomotypicalSynonymGroup
getHomotypicalGroupContainer(
565 HomotypicalGroup homotypicalGroup
) {
566 for (HomotypicalSynonymGroup group
: getHeterotypicSynonymGroups()) {
567 if (group
.getGroup().equals(homotypicalGroup
)) {
580 * @return a Set containing all composites that have been edited
582 public Set
<AbstractGroupedContainer
> getDirtyNames() {
583 Set
<AbstractGroupedContainer
> dirtyNames
= new HashSet
<AbstractGroupedContainer
>();
585 for (AbstractGroupedContainer composite
: getGroupedContainers()) {
586 if (composite
.isDirty()) {
587 dirtyNames
.add(composite
);
596 * getGroupedContainers
599 * @return a {@link java.util.List} object.
601 public List
<AbstractGroupedContainer
> getGroupedContainers() {
602 List
<AbstractGroupedContainer
> groupedComposites
= new ArrayList
<AbstractGroupedContainer
>();
604 for (AbstractGroup group
: getAllGroups()) {
605 groupedComposites
.addAll(group
.getGroupedContainers());
608 return groupedComposites
;
616 * @return a {@link java.util.List} object.
618 public List
<AbstractGroup
> getAllGroups() {
619 List
<AbstractGroup
> allGroups
= new ArrayList
<AbstractGroup
>();
621 allGroups
.add(getAcceptedGroup());
623 // List<HomotypicalSynonymGroup> grps = getHeterotypicSynonymGroups(); // UNUSED => remove
625 heterotypicSynonymGroups
= getHeterotypicSynonymGroups();
627 if (heterotypicSynonymGroups
!= null) {
628 allGroups
.addAll(heterotypicSynonymGroups
);
631 if (misappliedGroup
!= null) {
632 allGroups
.add(misappliedGroup
);
641 * @see org.eclipse.ui.part.EditorPart#isDirty()
645 public boolean isDirty() {
646 return editor
.isDirty();
652 * @see org.eclipse.ui.part.WorkbenchPart#dispose()
656 public void dispose() {
657 conversation
.unregisterForDataStoreChanges(this);
664 * @see org.eclipse.ui.part.EditorPart#isSaveAsAllowed()
668 public boolean isSaveAsAllowed() {
675 * @see org.eclipse.ui.ISelectionListener#selectionChanged(org.eclipse.ui.
676 * IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
680 public void selectionChanged(IWorkbenchPart part
, ISelection selection
) {
689 * @return a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor}
693 public TaxonNameEditor
getEditor() {
699 * Getter for the field <code>selectedObject</code>.
703 * {@link eu.etaxonomy.taxeditor.editor.name.container.AbstractGroupedContainer}
706 public AbstractGroupedContainer
getSelectedContainer() {
708 TaxonBase selectedTaxonBase
= null;
710 TaxonEditorInput input
= (TaxonEditorInput
) editor
.getEditorInput();
711 if (input
.getInitiallySelectedTaxonBase() != null) {
712 selectedTaxonBase
= input
.getInitiallySelectedTaxonBase();
714 if (selection
!= null) {
715 selectedTaxonBase
= selection
;
719 return (selectedTaxonBase
!= null) ?
getContainer(selectedTaxonBase
)
720 : getAcceptedNameContainer();
729 public void dragEntered() {
731 getControl().setBackground(
732 AbstractUtility
.getColor(Resources
.COLOR_DRAG_ENTER
));
741 public void dragLeft() {
742 getControl().setBackground(
743 AbstractUtility
.getColor(Resources
.COLOR_COMPOSITE_BACKGROUND
));
749 * setMisapplicationsGroup
752 * @param misappliedGroup
754 * {@link eu.etaxonomy.taxeditor.editor.name.container.MisappliedGroup}
757 public void setMisapplicationsGroup(MisappliedGroup misappliedGroup
) {
758 this.misappliedGroup
= misappliedGroup
;
765 * eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#isRedrawing()
775 public boolean isRedrawing() {
784 * @return a {@link org.eclipse.ui.forms.widgets.FormToolkit} object.
786 public FormToolkit
getToolkit() {
787 return managedForm
.getToolkit();
792 * getHeterotypicSynonymGroups
795 * @return a {@link java.util.List} object.
797 public List
<HomotypicalSynonymGroup
> getHeterotypicSynonymGroups() {
798 return heterotypicSynonymGroups
;
803 * addHeterotypicSynonymGroup
808 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
811 public void addHeterotypicSynonymGroup(HomotypicalSynonymGroup group
) {
812 heterotypicSynonymGroups
.add(group
);
817 * getHomotypicSynonymGroup
821 * {@link eu.etaxonomy.taxeditor.editor.name.container.HomotypicalSynonymGroup}
824 public AcceptedGroup
getAcceptedGroup() {
825 return acceptedGroup
;
830 * @param acceptedGroup
832 public void setAcceptedGroup(AcceptedGroup acceptedGroup
) {
833 this.acceptedGroup
= acceptedGroup
;
838 * Getter for the field <code>misappliedGroup</code>.
842 * {@link eu.etaxonomy.taxeditor.editor.name.container.MisappliedGroup}
845 public MisappliedGroup
getMisappliedGroup() {
846 return misappliedGroup
;
849 // TODO not very useful at the moment
857 public boolean isActive() {
858 IWorkbenchPart activePart
= AbstractUtility
.getActivePart();
859 return editor
.equals(activePart
);
870 public boolean onComplete() {
871 getContainer(objectAffectedByLastOperation
).setSelected();
877 public void partChanged(Integer eventType
, IWorkbenchPartReference partRef
) {
878 if (!partRef
.getPart(false).equals(editor
)) {
879 // getSelectedObject().colorSelected(AbstractGroupedContainer.SELECTED_NO_FOCUS);
884 * @param retainedGroup
886 public void removeGroup(AbstractGroup group
) {
890 //if (heterotypicSynonymGroups != null) {
891 heterotypicSynonymGroups
.remove(group
);
900 public AbstractGroupedContainer
getContainer(TaxonBase taxonBase
) {
901 List
<AbstractGroupedContainer
> groupedContainers
= getGroupedContainers();
902 for (AbstractGroupedContainer container
: groupedContainers
) {
903 if (container
.getData().equals(taxonBase
)
904 && container
.getNameViewer().getTextWidget() != null) {
908 return getAcceptedNameContainer();
912 * @see eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#setOnError()
915 public void setOnError() {
916 Color disabledColor
= AbstractUtility
.getColor(Resources
.COLOR_EDITOR_ERROR
);
917 setEnabled(false, disabledColor
);
921 * @see eu.etaxonomy.taxeditor.editor.IMultiPageTaxonEditorPage#setDisabled()
924 public void setDisabled(){
925 Color disabledColor
= AbstractUtility
.getColor(Resources
.COLOR_TEXT_DISABLED_BACKGROUND
);
929 protected void setEnabled(boolean enabled
, Color background
) {
931 for(AbstractGroupedContainer groupedContainer
: getGroupedContainers()){
932 groupedContainer
.setEnabled(enabled
);
935 // send an empty selection to the current provider - TODO only on error ???
937 getManagedForm().setInput(null);
939 for (AbstractGroupedContainer groupedContainer
: getGroupedContainers()) {
940 groupedContainer
.setBackground(background
);
943 getControl().setBackground(background
);
947 public void setEnabled(boolean enabled
) {
948 Color background
= AbstractUtility
.getColor(enabled ? Resources
.COLOR_COMPOSITE_BACKGROUND
: Resources
.COLOR_TEXT_DISABLED_BACKGROUND
);
949 setEnabled(enabled
, background
);