/**
- *
+ *
*/
package eu.etaxonomy.taxeditor.ui.combo;
import eu.etaxonomy.cdm.model.common.DefinedTerm;
import eu.etaxonomy.cdm.model.common.DefinedTermBase;
import eu.etaxonomy.cdm.model.common.TermType;
+import eu.etaxonomy.cdm.model.common.TermVocabulary;
+import eu.etaxonomy.taxeditor.model.MessagingUtils;
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.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.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
DisposeListener, IEnableableFormElement, ISelectable {
private static final int DEFAULT_VISIBLE_ITEMS = 10;
-
+
private T selection;
private T emptyElement;
private static String EMPTY_ELEMENT_LABEL = "";
protected Label label;
- private Combo combo;
+ private final Combo combo;
private ArrayList<T> terms;
private Comparator<T> termComparator;
- private Class<T> termClass;
+ private final Class<T> termClass;
private List<T> customPreferredTerms;
- /**
- * <p>
- * Constructor for AbstractTermComboElement.
- * </p>
- *
- * @param parentElement
- * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
- * object.
- * @param style
- * a int.
- * @param formFactory
- * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
- * object.
- * @param labelString
- * a {@link java.lang.String} object.
- * @param selection
- * a T object.
- * @param visibleItems
- * a int.
- * @param <T>
- * a T object.
- */
public TermComboElement(CdmFormFactory formFactory,
ICdmFormElement parentElement, TermType termType, String labelString, T selection,
int style) {
- super(formFactory, parentElement);
-
- this.termClass = (Class<T>) DefinedTerm.class;
-
- if (labelString != null) {
- label = formFactory.createLabel(getLayoutComposite(), labelString);
- addControl(label);
- }
-
- // create combo
- combo = new Combo(getLayoutComposite(), SWT.BORDER | SWT.READ_ONLY);
- addControl(combo);
- combo.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
- combo.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS);
-
- populateTerms(filterDefinedTermByTermType(getPreferredTerms(), termType));
-
- combo.addSelectionListener(this);
- combo.addDisposeListener(this);
- PreferencesUtil.getPreferenceStore().addPropertyChangeListener(this);
-
- if (selection != null) {
- setSelection(selection);
- }
+ this(formFactory, parentElement, null, termType, null, labelString, selection, style);
}
- /**
- * <p>
- * Constructor for AbstractTermComboElement.
- * </p>
- *
- * @param parentElement
- * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
- * object.
- * @param style
- * a int.
- * @param formFactory
- * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
- * object.
- * @param labelString
- * a {@link java.lang.String} object.
- * @param selection
- * a T object.
- * @param visibleItems
- * a int.
- * @param <T>
- * a T object.
- */
public TermComboElement(CdmFormFactory formFactory,
- ICdmFormElement parentElement, Class<T> termClass, String labelString, T selection,
- int style) {
- super(formFactory, parentElement);
-
- this.termClass = termClass;
-
- if (labelString != null) {
- label = formFactory.createLabel(getLayoutComposite(), labelString);
- addControl(label);
- }
-
- // create combo
- combo = new Combo(getLayoutComposite(), SWT.BORDER | SWT.READ_ONLY);
- addControl(combo);
- combo.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
- combo.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS);
-
- populateTerms(getPreferredTerms());
-
- combo.addSelectionListener(this);
- combo.addDisposeListener(this);
- PreferencesUtil.getPreferenceStore().addPropertyChangeListener(this);
+ ICdmFormElement parentElement, TermVocabulary<?> termVocabulary, String labelString, T selection,
+ int style) {
+ this(formFactory, parentElement, null, null, termVocabulary, labelString, selection, style);
+ }
- if (selection != null) {
- setSelection(selection);
- }
+ public TermComboElement(CdmFormFactory formFactory,
+ ICdmFormElement parentElement, Class<T> termClass, String labelString, T selection,
+ int style) {
+ this(formFactory, parentElement, termClass, null, null, labelString, selection, style);
+ }
+
+ private TermComboElement(CdmFormFactory formFactory,
+ ICdmFormElement parentElement, Class<T> termClass, TermType termType, TermVocabulary<?> termVocabulary, String labelString, T selection,
+ int style) {
+ super(formFactory, parentElement);
+
+ if(termClass!=null){
+ this.termClass = termClass;
+ }
+ else{
+ this.termClass = (Class<T>) DefinedTerm.class;
+ }
+
+ if (labelString != null) {
+ label = formFactory.createLabel(getLayoutComposite(), labelString);
+ addControl(label);
+ }
+
+ // create combo
+ combo = new Combo(getLayoutComposite(), SWT.BORDER | SWT.READ_ONLY );//FIXME: removed this parameter seems break windows version: | style
+ addControl(combo);
+ combo.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
+ 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));
+ }
+ else if(termVocabulary!=null){
+ populateTerms((List<T>) getTermManager().getPreferredTerms(termVocabulary));
+ }
+ else if(this.termClass!=null){
+ populateTerms(getPreferredTerms());
+ }
+
+ combo.addSelectionListener(this);
+ combo.addDisposeListener(this);
+ PreferencesUtil.getPreferenceStore().addPropertyChangeListener(this);
+
+ if (selection != null) {
+ setSelection(selection);
+ }
}
/**
* <p>
* Getter for the field <code>selection</code>.
* </p>
- *
+ *
* @return a T object.
*/
public T getSelection() {
/**
* <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
+ * <p>Passing <code>null</code> to this method will set the selection to
* the empty element and effectively clear the selection</p>
- *
+ *
* @param selection
* a T object or <code>null</code> to clear the selection
*/
- public void setSelection(T selection) {
+ public void setSelection(T selection) {
this.selection = selection;
-
+
this.selection = selection;
-
+
Listener[] listeners = combo.getListeners(SWT.Selection);
for (Listener listener : listeners) {
/**
* Fills the combo with elements and sets up the convenience functions
* for selection index
- *
+ *
* @param preferredTerms
*/
private void populateTerms(List<T> preferredTerms) {
if (label == null) {
if (term.getTitleCache() != null) {
label = term.getTitleCache();
- StoreUtil.warn(getClass(),
+ MessagingUtils.warn(getClass(),
"Term does not have a default language representation: " + label
+ ", " + term.getUuid());
} else {
label = "Unknown";
- StoreUtil.warn(getClass(),
+ MessagingUtils.warn(getClass(),
"Representation Label and TitleCache empty for term: "
+ term + ", " + term.getUuid());
}
* @see eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
*/
/** {@inheritDoc} */
- public void setEnabled(boolean enabled) {
+ @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(){
/**
* May be overridden by derived classes if the desired label string does not
* reside in term.getLabel();
- *
+ *
* @param term
* a T object.
* @return a {@link java.lang.String} object.
}
/**
- *
- *
+ *
+ *
* @param term
*/
private void createTermNotInPreferredTerms(T term) {
* <p>
* addSelectionListener
* </p>
- *
+ *
* @param listener
* a {@link org.eclipse.swt.events.SelectionListener} object.
*/
* <p>
* removeSelectionListener
* </p>
- *
+ *
* @param listener
* a {@link org.eclipse.swt.events.SelectionListener} object.
*/
/*
* (non-Javadoc)
- *
+ *
* @see
* org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
* .events.SelectionEvent)
*/
/** {@inheritDoc} */
- public void widgetSelected(SelectionEvent e) {
+ @Override
+ public void widgetSelected(SelectionEvent e) {
selection = terms.get(combo.getSelectionIndex());
firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
}
/*
* (non-Javadoc)
- *
+ *
* @see java.beans.PropertyChangeListener#propertyChange(java.beans.
* PropertyChangeEvent)
*/
/** {@inheritDoc} */
- public void propertyChange(PropertyChangeEvent event) {
+ @Override
+ public void propertyChange(PropertyChangeEvent event) {
super.propertyChange(event);
if (event != null
&& PreferencesUtil.PREFERRED_TERMS_CHANGE.equals(event
}
/** {@inheritDoc} */
- public void setSelected(boolean selected) {
+ @Override
+ public void setSelected(boolean selected) {
setBackground(selected ? SELECTED : getPersistentBackground());
}
/** {@inheritDoc} */
- public void widgetDisposed(DisposeEvent e) {
+ @Override
+ public void widgetDisposed(DisposeEvent e) {
PreferencesUtil.getPreferenceStore().removePropertyChangeListener(this);
}
// not used
/** {@inheritDoc} */
- public void widgetDefaultSelected(SelectionEvent e) {
+ @Override
+ public void widgetDefaultSelected(SelectionEvent e) {
}
/** {@inheritDoc} */
- public void setIrrelevant(boolean irrelevant) {
+ @Override
+ public void setIrrelevant(boolean irrelevant) {
String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT
: Resources.COLOR_COMPOSITE_BACKGROUND;
/** {@inheritDoc} */
@Override
public void setBackground(Color color) {
- if (label != null)
- label.setBackground(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){
/**
* <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
+ * of displaying the preferred terms for the T type will be overridden and the combo will only display the
* given terms. Also, any previous selection will be reseted.</p>
- *
+ *
* <p>To return to the default of displaying the preferred terms, simply pass <code>null</code>.</p>
- *
+ *
* @param terms a {@link List} of T objects or <code>null</code> for default preferred terms
*/
public void setTerms(List<T> terms) {
customPreferredTerms = terms;
populateTerms(customPreferredTerms);
}
-
- private List<T> filterDefinedTermByTermType(List<T> terms, TermType termType) {
- List<T> definedTerms = new ArrayList<T>();
- for(T term : terms){
- if(term.getTermType().equals(termType)) {
- definedTerms.add(term);
- }
- }
- return definedTerms;
- }
+
}