ref #5305 Refactored combo elements
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / combo / TermComboElement.java
index e2da02ba34aa27074a8eec4011c0cf49dec0ef83..65ba7e0192e100e2418a08c65901f691239e740c 100644 (file)
@@ -10,17 +10,9 @@ import java.util.Comparator;
 import java.util.List;
 
 import org.eclipse.jface.util.PropertyChangeEvent;
-import org.eclipse.jface.viewers.ComboViewer;
 import org.eclipse.swt.SWT;
-import org.eclipse.swt.events.DisposeEvent;
-import org.eclipse.swt.events.DisposeListener;
 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.swt.widgets.Listener;
-import org.eclipse.ui.forms.widgets.TableWrapData;
 
 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
 import eu.etaxonomy.cdm.model.common.TermType;
@@ -28,42 +20,24 @@ import eu.etaxonomy.cdm.model.common.TermVocabulary;
 import eu.etaxonomy.taxeditor.model.MessagingUtils;
 import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
-import eu.etaxonomy.taxeditor.preference.Resources;
 import eu.etaxonomy.taxeditor.store.CdmStore;
-import eu.etaxonomy.taxeditor.store.StoreUtil;
 import eu.etaxonomy.taxeditor.store.TermManager;
-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.ICdmFormElement;
-import eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement;
-import eu.etaxonomy.taxeditor.ui.element.ISelectable;
-import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;
 
 /**
- * <p>
- * Abstract AbstractTermComboElement class.
- * </p>
- *
  * @author n.hoffmann
  * @created Nov 5, 2009
  * @version 1.0
  * @param <T>
  */
 public class TermComboElement<T extends DefinedTermBase>
-               extends AbstractCdmFormElement implements SelectionListener,
-               DisposeListener, IEnableableFormElement, ISelectable {
-
-       private static final int DEFAULT_VISIBLE_ITEMS = 10;
-
-       private T selection;
+               extends AbstractComboElement<T> {
 
        private T emptyElement;
        private static String EMPTY_ELEMENT_LABEL = "";
 
-       protected Label label;
-       private final Combo combo;
-
        private ArrayList<T> terms;
 
        private Comparator<T> termComparator;
@@ -105,20 +79,9 @@ public class TermComboElement<T extends DefinedTermBase>
         this.addEmptyElement = addEmptyElement;
 
         if (labelString != null) {
-            label = formFactory.createLabel(getLayoutComposite(), labelString);
-            addControl(label);
+            label.setText(labelString);
         }
 
-        // create combo
-        ComboViewer viewer = new ComboViewer(getLayoutComposite(), SWT.BORDER | SWT.READ_ONLY );
-        combo = viewer.getCombo();
-        addControl(combo);
-        TableWrapData fill_HORIZONTALLY = LayoutConstants.FILL_HORIZONTALLY();
-        combo.setLayoutData(fill_HORIZONTALLY);
-        fill_HORIZONTALLY.maxWidth = 50;
-        combo.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS);
-
-
         if(termType!=null){
             //TODO try to remove generic T and avoid classes to be used
             populateTerms((List<T>) getTermManager().getPreferredTerms(termType));
@@ -139,17 +102,6 @@ public class TermComboElement<T extends DefinedTermBase>
         }
        }
 
-       /**
-        * <p>
-        * Getter for the field <code>selection</code>.
-        * </p>
-        *
-        * @return a T object.
-        */
-       public T getSelection() {
-               return selection;
-       }
-
        /**
         * <p>Sets the selection of the combo to the given T object.</p>
         * <p>Passing <code>null</code> to this method will set the selection to
@@ -158,7 +110,8 @@ public class TermComboElement<T extends DefinedTermBase>
         * @param selection
         *            a T object or <code>null</code> to clear the selection
         */
-       public void setSelection(T selection) {
+       @Override
+    public void setSelection(T selection) {
                this.selection = selection;
 
                Listener[] listeners = combo.getListeners(SWT.Selection);
@@ -243,31 +196,6 @@ public class TermComboElement<T extends DefinedTermBase>
                combo.select(index);
        }
 
-       /*
-        * (non-Javadoc)
-        * @see eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
-        */
-       /** {@inheritDoc} */
-       @Override
-    public void setEnabled(boolean enabled) {
-               combo.setEnabled(enabled);
-       }
-
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#isEnabled()
-        */
-       @Override
-       public boolean isEnabled() {
-           return combo.isEnabled();
-       }
-
-       /**
-        * <p>
-        * preferredTerms
-        * </p>
-        *
-        * @return a {@link java.util.List} object.
-        */
        protected List<T> getPreferredTerms(){
            List<T> preferredTerms = new ArrayList<T>();
                if (customPreferredTerms != null){
@@ -326,37 +254,6 @@ public class TermComboElement<T extends DefinedTermBase>
                populateTerms(preferredTerms);
        }
 
-       /**
-        * <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);
-       }
-
-       /*
-        * (non-Javadoc)
-        *
-        * @see
-        * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
-        * .events.SelectionEvent)
-        */
        /** {@inheritDoc} */
        @Override
     public void widgetSelected(SelectionEvent e) {
@@ -364,12 +261,6 @@ public class TermComboElement<T extends DefinedTermBase>
                firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
        }
 
-       /*
-        * (non-Javadoc)
-        *
-        * @see java.beans.PropertyChangeListener#propertyChange(java.beans.
-        * PropertyChangeEvent)
-        */
        /** {@inheritDoc} */
        @Override
     public void propertyChange(PropertyChangeEvent event) {
@@ -381,65 +272,14 @@ public class TermComboElement<T extends DefinedTermBase>
                }
        }
 
-       /** {@inheritDoc} */
-       @Override
-    public void setSelected(boolean selected) {
-               setBackground(selected ? SELECTED : getPersistentBackground());
-       }
-
-       /** {@inheritDoc} */
-       @Override
-    public void widgetDisposed(DisposeEvent e) {
-               PreferencesUtil.getPreferenceStore().removePropertyChangeListener(this);
-       }
-
-       // not used
-       /** {@inheritDoc} */
-       @Override
-    public void widgetDefaultSelected(SelectionEvent 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) {
-               if (label != null) {
-            label.setBackground(color);
-        }
-       }
-
-       /**
-        *
-        */
        protected TermManager getTermManager() {
                return CdmStore.getTermManager();
        }
 
-       /**
-        *
-        * @return
-        */
        public int getVisibleItemCount(){
                return combo.getVisibleItemCount();
        }
 
-       /**
-        *
-        * @param count
-        */
-       public void setVisibleItemCount(int count){
-               combo.setVisibleItemCount(count);
-       }
-
        /**
         * <p>A {@link List} of term objects may be passed to this combo box. In this case, the default behaviour
         * of displaying the preferred terms for the T type will be overridden and the combo will only display the