Merge branch 'release/5.18.0'
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / combo / EnumComboElement.java
index 05df291ba4976995b60f7d1197fb31d087479ae1..48cb1a08646925d2f23da86839b39cd464f531c0 100644 (file)
@@ -1,4 +1,3 @@
-// $Id$
 /**
  * Copyright (C) 2007 EDIT
  * European Distributed Institute of Taxonomy
@@ -13,47 +12,49 @@ package eu.etaxonomy.taxeditor.ui.combo;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map.Entry;
 
-import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.SelectionEvent;
-import org.eclipse.swt.events.SelectionListener;
-import org.eclipse.swt.graphics.Color;
 import org.eclipse.swt.widgets.Combo;
-import org.eclipse.swt.widgets.Label;
+import org.eclipse.ui.forms.widgets.TableWrapData;
 
-import eu.etaxonomy.cdm.model.common.IEnumTerm;
-import eu.etaxonomy.cdm.model.common.OriginalSourceType;
+import eu.etaxonomy.cdm.model.media.ExternalLinkType;
+import eu.etaxonomy.cdm.model.name.NameRelationship;
 import eu.etaxonomy.cdm.model.name.NomenclaturalCode;
+import eu.etaxonomy.cdm.model.name.NomenclaturalCodeEdition;
+import eu.etaxonomy.cdm.model.name.TaxonName;
 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
+import eu.etaxonomy.cdm.model.reference.OriginalSourceType;
 import eu.etaxonomy.cdm.model.reference.ReferenceType;
+import eu.etaxonomy.cdm.model.taxon.TaxonNodeStatus;
+import eu.etaxonomy.cdm.model.term.IEnumTerm;
+import eu.etaxonomy.taxeditor.l10n.Messages;
 import eu.etaxonomy.taxeditor.model.AbstractUtility;
-import eu.etaxonomy.taxeditor.preference.Resources;
-import eu.etaxonomy.taxeditor.store.StoreUtil;
-import eu.etaxonomy.taxeditor.ui.campanula.compatibility.ICdmFormElement;
-import eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement;
 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
 import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
-import eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement;
-import eu.etaxonomy.taxeditor.ui.element.ISelectable;
-import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;
+import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
+import eu.etaxonomy.taxeditor.ui.section.name.NameRelationshipDetailElement;
+import eu.etaxonomy.taxeditor.ui.section.name.NomenclaturalStatusElement;
+import eu.etaxonomy.taxeditor.ui.section.name.NomenclaturalStatusSection;
 
 /**
- * <p>
- * Abstract AbstractEnumComboElement class.
- * </p>
- *
  * @author n.hoffmann
  * @created Mar 16, 2010
- * @version 1.0
  */
 public class EnumComboElement<T extends IEnumTerm<T>> extends
-               AbstractCdmFormElement implements SelectionListener,
-               IEnableableFormElement, ISelectable {
+               AbstractComboElement<T>  {
+
+       //TODO RL
+       public void setVisible(boolean b){
+               combo.setVisible(b);
+       }
 
-       private static CdmEnumDataHolder[] cdmEnumDataHolders = {
+
+        private  static  CdmEnumDataHolder[] cdmEnumDataHolders = {
                new CdmEnumDataHolder<NomenclaturalCode>(){
 
                        @Override
@@ -63,14 +64,15 @@ public class EnumComboElement<T extends IEnumTerm<T>> extends
 
                        @Override
                        public Collection<NomenclaturalCode> getElements() {
-                               return  Arrays.asList(NomenclaturalCode.values());
+                               Collection<NomenclaturalCode> result = new ArrayList<>(Arrays.asList(NomenclaturalCode.values()));
+               result.remove(NomenclaturalCode.ICVCN);
+                return  result;
                        }
 
                        @Override
                        public Class<NomenclaturalCode> getClazz() {
                                return NomenclaturalCode.class;
                        }
-
                },
                new CdmEnumDataHolder<ReferenceType>(){
 
@@ -108,6 +110,24 @@ public class EnumComboElement<T extends IEnumTerm<T>> extends
                        }
 
                },
+               new CdmEnumDataHolder<ExternalLinkType>(){
+
+            @Override
+            public String getName() {
+                return "Type";
+            }
+
+            @Override
+            public Collection<ExternalLinkType> getElements() {
+                return Arrays.asList(ExternalLinkType.values());
+            }
+
+            @Override
+            public Class<ExternalLinkType> getClazz() {
+                return ExternalLinkType.class;
+            }
+
+        },
                new CdmEnumDataHolder<OriginalSourceType>(){
 
                        @Override
@@ -125,55 +145,73 @@ public class EnumComboElement<T extends IEnumTerm<T>> extends
                                return OriginalSourceType.class;
                        }
 
-               }
+               },
+        new CdmEnumDataHolder<NomenclaturalCodeEdition>(){
 
-       };
+            @Override
+            public String getName() {
+                return "Nomenclatural Code Edition";
+            }
+
+            @Override
+            public Collection<NomenclaturalCodeEdition> getElements() {
+                return Arrays.asList(NomenclaturalCodeEdition.values());
+            }
+
+            @Override
+            public Class<NomenclaturalCodeEdition> getClazz() {
+                return NomenclaturalCodeEdition.class;
+            }
+
+        },
+               new CdmEnumDataHolder<TaxonNodeStatus>(){
+
+            @Override
+            public String getName() {
+                return "Taxon Node Status";
+            }
+
+            @Override
+            public Collection<TaxonNodeStatus> getElements() {
+                return Arrays.asList(TaxonNodeStatus.values());
+            }
 
-       private static final int DEFAULT_VISIBLE_ITEMS = 10;
+            @Override
+            public Class<TaxonNodeStatus> getClazz() {
+                return TaxonNodeStatus.class;
+            }
 
-       protected T selection;
+        }
 
-       protected List<T> elementTypeList = new ArrayList<T>();
+       };
 
-       private final Label label;
-       protected Combo combo;
+       protected List<T> elementTypeList = new ArrayList<>();
 
        private final Class<T> enumType;
 
-       /**
-        * <p>
-        * Constructor for AbstractEnumComboElement.
-        * </p>
-        *
-        * @param formFactory
-        *            a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
-        *            object.
-        * @param parentElement
-        *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
-        *            object.
-        * @param labelString
-        *            a {@link java.lang.String} object.
-        * @param <T>
-        *            a T object.
-        */
        public EnumComboElement(CdmFormFactory formFactory,
-                       ICdmFormElement parentElement, Class<T> enumType, int style) {
-               super(formFactory, parentElement);
+                       ICdmFormElement parentElement, Class<T> enumType, Comparator<T> comparator, int style, boolean hasNullValue) {
+               super(formFactory, parentElement, hasNullValue);
                this.enumType = enumType;
-               label = formFactory.createLabel(getLayoutComposite(), getDefaultLabelString());
-               addControl(label);
+               label.setText(getDefaultLabelString());
+               populateTypes(comparator);
+               combo.addSelectionListener(this);
+               addContentProposalAdapter();
+       }
 
-               // create combo
-               combo = new Combo(getLayoutComposite(), SWT.BORDER | SWT.READ_ONLY);
-               addControl(combo);
-               combo.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
-               setVisibleItemCount(DEFAULT_VISIBLE_ITEMS);
+       public void setIndent(int indent) {
+       TableWrapData layoutData = new TableWrapData();
+        layoutData.indent = indent;
+        label.setLayoutData(layoutData);
 
-               populateTypes();
+        getLayoutComposite().layout();
+       }
 
-               combo.addSelectionListener(this);
+       public Combo getCombo(){
+           return combo;
        }
 
+
        private String getDefaultLabelString() {
                if(enumType.equals(ReferenceType.class)){
                        return "Reference Type";
@@ -183,131 +221,96 @@ public class EnumComboElement<T extends IEnumTerm<T>> extends
                        return "Orig. Source Type";
                } else if(enumType.equals(SpecimenOrObservationType.class)) {
                        return "Spec./Obs. Type";
-               }
+               } else if(enumType.equals(ExternalLinkType.class)) {
+            return "Type";
+        } else if(enumType.equals(NomenclaturalCodeEdition.class)) {
+            return "Code Edition";
+        }else if(enumType.equals(TaxonNodeStatus.class)) {
+            return Messages.EnumCombo_Placement_status;
+        }
                return "No Label";
        }
 
-       /**
-        * <p>
-        * populateTypes
-        * </p>
-        */
-    private void populateTypes(){
-        Collection<T> elementsForClass = getElementsForClass(enumType);
+    private void populateTypes(Comparator<T> comparator){
+        List<T> elementsForClass = new ArrayList<T>(getElementsForClass(enumType));
+        if(comparator!=null){
+            Collections.sort(elementsForClass, comparator);
+        }
+        int index = 0;
+        if (hasNullValue){
+            combo.add("", index);
+            index++;
+        }
         // special hierarchical order for specimens
         if(enumType.equals(SpecimenOrObservationType.class)){
             LinkedHashMap<T, String> orderedTerms = AbstractUtility.orderTerms(elementsForClass);
             for(Entry<T, String> keyLabelPair : orderedTerms.entrySet()){
                 elementTypeList.add(keyLabelPair.getKey());
-                combo.add(keyLabelPair.getValue());
+                combo.add(keyLabelPair.getValue(), index);
+                index++;
+            }
+        }else if(enumType.equals(NomenclaturalCodeEdition.class)){
+            NomenclaturalCode code = null;
+
+            ICdmFormElement parentElement = getParentElement();
+            if (parentElement instanceof NameRelationshipDetailElement){
+                NameRelationship rel = ((NameRelationshipDetailElement)parentElement).getEntity();
+                code = rel.getToName().getNameType();
+            }else if (parentElement instanceof NomenclaturalStatusElement){
+                ICdmFormElement parent = ((NomenclaturalStatusElement)parentElement).getParentElement();
+                TaxonName name = ((NomenclaturalStatusSection)parent).getEntity();
+                code = name.getNameType();
+            }
+            List<NomenclaturalCodeEdition> elements = NomenclaturalCodeEdition.forCode(code);
+            LinkedHashMap<NomenclaturalCodeEdition, String> orderedTerms = AbstractUtility.orderTerms(elements);
+            for (NomenclaturalCodeEdition codeEdition: elements){
+                    elementTypeList.add((T)codeEdition);
+                    combo.add(codeEdition.getLabel(), index);
+                    index++;
             }
         }
         // default order
         else{
-            for(T enumElement : getElementsForClass(enumType)){
+            for(T enumElement : elementsForClass){
                 elementTypeList.add(enumElement);
-                combo.add(((Enum) enumElement).name());
+                if (enumElement instanceof IEnumTerm)  {
+                    combo.add(((IEnumTerm) enumElement).getLabel(), index);
+                    index++;
+                }else{
+                    combo.add(((Enum) enumElement).name(), index);
+                    index++;
+                }
             }
         }
        }
 
-       /**
-        * <p>
-        * Setter for the field <code>selection</code>.
-        * </p>
-        *
-        * @param selection
-        *            the selection to set
-        */
-       public void setSelection(T selection) {
-               this.selection = selection;
-               combo.select(elementTypeList.indexOf(selection));
-       }
-
-       /**
-        * <p>
-        * addSelectionListener
-        * </p>
-        *
-        * @param listener
-        *            a {@link org.eclipse.swt.events.SelectionListener} object.
-        */
-       public void addSelectionListener(SelectionListener listener) {
-               combo.addSelectionListener(listener);
-       }
-
-       /**
-        * <p>
-        * removeSelectionListener
-        * </p>
-        *
-        * @param listener
-        *            a {@link org.eclipse.swt.events.SelectionListener} object.
-        */
-       public void removeSelectionListener(SelectionListener listener) {
-               combo.removeSelectionListener(listener);
-       }
-
-       /** {@inheritDoc} */
        @Override
-    public void setSelected(boolean selected) {
-               setBackground(selected ? SELECTED : getPersistentBackground());
-       }
-
-       /**
-        * <p>
-        * Getter for the field <code>selection</code>.
-        * </p>
-        *
-        * @return the selection
-        */
-       public T getSelection() {
-               return selection;
-       }
-
-       /** {@inheritDoc} */
-       @Override
-    public void setEnabled(boolean enabled) {
-               combo.setEnabled(enabled);
+    public void setSelection(T selection) {
+               this.selection = selection;
+               int index = elementTypeList.indexOf(selection);
+               if (hasNullValue && selection != null){
+                   index++;
+               }
+               combo.select(index);
        }
-
-       /*
-        * (non-Javadoc)
-        *
-        * @see
-        * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
-        * .events.SelectionEvent)
-        */
        /** {@inheritDoc} */
        @Override
     public void widgetSelected(SelectionEvent e) {
-               selection = elementTypeList.get(combo.getSelectionIndex());
-               firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
-       }
-
-       /** {@inheritDoc} */
-       @Override
-    public void setIrrelevant(boolean irrelevant) {
-               String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT
-                               : Resources.COLOR_COMPOSITE_BACKGROUND;
-
-               Color color = StoreUtil.getColor(colorId);
-               combo.setBackground(color);
-       }
-
-       /** {@inheritDoc} */
-       @Override
-       public void setBackground(Color color) {
-               label.setBackground(color);
-       }
 
-       /** {@inheritDoc} */
-       @Override
-    public void widgetDefaultSelected(SelectionEvent e) {
-       }
+        int index = combo.getSelectionIndex();
+        if (index == -2){
+            return;
+        }
+        if (hasNullValue ){
+            index--;
+        }
+        if (index<0){
+            selection = null;
+        }else{
+            selection = elementTypeList.get(index);
+        }
 
-       public void setVisibleItemCount(int visibleItems){
-               combo.setVisibleItemCount(visibleItems);
+               firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
        }
 
        private Collection<T> getElementsForClass(Class<T> clazz){
@@ -332,4 +335,6 @@ public class EnumComboElement<T extends IEnumTerm<T>> extends
                String getName();
                Collection<T> getElements();
        }
+
+
 }