minor

[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / AbstractEntityCollectionSection.java

diff --git a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/AbstractEntityCollectionSection.java b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/AbstractEntityCollectionSection.java
index 693a54028bdb1c7e4a9849418f9105eabd084cb2..7ea27db1ea146b2ce95020f1f9c33c6b631a440e 100644 (file)
--- a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/AbstractEntityCollectionSection.java
+++ b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/AbstractEntityCollectionSection.java
@@ -3,8 +3,12 @@
  */
 package eu.etaxonomy.taxeditor.ui.section;
 
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.EnumSet;
+import java.util.List;
 import java.util.Observable;
 import java.util.Observer;
 
@@ -29,7 +33,7 @@ import org.eclipse.ui.forms.widgets.ExpandableComposite;
 
 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
 import eu.etaxonomy.cdm.common.CdmUtils;
-import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;
+import eu.etaxonomy.cdm.model.permission.CRUD;
 import eu.etaxonomy.taxeditor.model.AbstractUtility;
 import eu.etaxonomy.taxeditor.model.ImageResources;
 import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
@@ -63,7 +67,7 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
 
        private String title;
 
-    private AbstractEntityCollectionElement entityCollectionElement;
+    private AbstractEntityCollectionElement<ENTITY> entityCollectionElement;
 
        public AbstractEntityCollectionSection(CdmFormFactory formFactory, ConversationHolder conversation, ICdmFormElement parentElement, String title, int style) {
                super(formFactory, parentElement, ExpandableComposite.CLIENT_INDENT | style);
@@ -85,17 +89,17 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
        protected Control createToolbar() {
                ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
 
-               Action addAction = new Action("add", IAction.AS_PUSH_BUTTON){
+               Action addAction = new Action("Add", IAction.AS_PUSH_BUTTON){
                        @Override
                        public void run() {
-                               ELEMENT element = createNewElement();
-                               if(element != null){
-                                       addElement(element);
-                                       if(! getSection().isExpanded()) {
-                        getSection().setExpanded(true);
-                    }
-                                       internalUpdateSection(true);
-                               }
+                           ELEMENT element = createNewElement();
+                           if(element != null){
+                               addElement(element);
+                               if(! getSection().isExpanded()) {
+                                   getSection().setExpanded(true);
+                               }
+                               internalUpdateSection(true);
+                           }
                        }
                };
                addAction.setImageDescriptor(new ImageDescriptor() {
@@ -107,12 +111,46 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
                });
                addAction.setToolTipText(getTooltipString());
 
+               Action browseAction = null;
+               if(allowAddExisting()){
+                   browseAction = new Action("Browse", IAction.AS_PUSH_BUTTON){
+                       @Override
+                       public void run() {
+                           ELEMENT element = addExisting();
+                           if(element != null){
+                               addElement(element);
+                               if(! getSection().isExpanded()) {
+                                   getSection().setExpanded(true);
+                               }
+                               internalUpdateSection(true);
+                           }
+                       }
+                   };
+                   browseAction.setImageDescriptor(new ImageDescriptor() {
+
+                       @Override
+                       public ImageData getImageData() {
+                           return ImageResources.getImage(ImageResources.BROWSE_ICON).getImageData();
+                       }
+                   });
+                   browseAction.setToolTipText("Browse");
+               }
+
                toolBarManager.add(addAction);
+               if(browseAction!=null){
+                   toolBarManager.add(browseAction);
+               }
+
+               addAction(toolBarManager);
 
                return toolBarManager.createControl(this);
        }
 
-       /**
+    protected void addAction(ToolBarManager toolBarManager) {
+        // default implementation empty
+    }
+
+    /**
         * using this method is discouraged, use updateToolBar() instead
         */
        public void showToolbar(){
@@ -184,11 +222,13 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
         */
        private void renderContent(boolean forceExpansion)
        {
-               Collection<ELEMENT> elements = getCollection(getEntity());
+               Collection<ELEMENT> collection = getCollection(getEntity());
 
-               if(elements == null || elements.isEmpty()){
+               if(collection == null || collection.isEmpty()){
                        createEmptyContent();
                }else{
+                   List<ELEMENT> elements = new ArrayList<>(collection);
+                   Collections.sort(elements, getComparator());
                        createDynamicContents(elements);
                        forceExpansion = true;
                }
@@ -281,7 +321,7 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
        }
 
        private boolean expandSectionWhenContentAvailable(){
-               return PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.SHOULD_EXPAND_SECTION_WHEN_DATA_AVAILABLE);
+               return PreferencesUtil.getBooleanValue(IPreferenceKeys.SHOULD_EXPAND_SECTION_WHEN_DATA_AVAILABLE, true);
        }
 
        /**
@@ -301,7 +341,7 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
            }
        }
 
-    private void updateToolbar() {
+    protected void updateToolbar() {
         if(getEntity() != null && CdmStore.currentAuthentiationHasPermission(StoreUtil.getCdmEntity(getEntity()), UPDATE)){
             showToolbar();
         } else {
@@ -309,10 +349,17 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
         }
     }
 
-    public AbstractEntityCollectionElement getEntityCollectionElement() {
+    public AbstractEntityCollectionElement<ENTITY> getEntityCollectionElement() {
         return entityCollectionElement;
     }
 
+    /**
+     * Returns the {@link Comparator} specific for the ELEMENTs
+     * which is used to sort the elements
+     * @return the comparator for ELEMENT
+     */
+    public abstract Comparator<ELEMENT> getComparator();
+
        /**
         * Get the specific collection of this entity
         *
@@ -321,6 +368,7 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
         */
        public abstract Collection<ELEMENT> getCollection(ENTITY entity);
 
+
        /**
         * Create a new Element for this collection
         *
@@ -335,6 +383,23 @@ public abstract class AbstractEntityCollectionSection<ENTITY, ELEMENT> extends A
         */
        public abstract void addElement(ELEMENT element);
 
+       /**
+        * Add an existing element to the entities collection.
+        * @return the existing element
+        */
+       public abstract ELEMENT addExisting();
+
+       /**
+        * If <code>true</code> the section will also display
+        * a browse icon to choose from existing elements.
+        * <br>
+        * <b>Note:</b> when returning true you have to make sure
+        * to implement the {@link #addExisting()} method
+        * @return true if existing entities can be added;
+        * false otherwise
+        */
+       public abstract boolean allowAddExisting();
+
        /**
         * Remove an element from the entities collection
         *