4 package eu
.etaxonomy
.taxeditor
.ui
.combo
;
6 import java
.util
.ArrayList
;
7 import java
.util
.Arrays
;
8 import java
.util
.Collections
;
9 import java
.util
.Comparator
;
10 import java
.util
.List
;
12 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
13 import org
.eclipse
.swt
.SWT
;
14 import org
.eclipse
.swt
.events
.DisposeEvent
;
15 import org
.eclipse
.swt
.events
.DisposeListener
;
16 import org
.eclipse
.swt
.events
.SelectionEvent
;
17 import org
.eclipse
.swt
.events
.SelectionListener
;
18 import org
.eclipse
.swt
.graphics
.Color
;
19 import org
.eclipse
.swt
.widgets
.Combo
;
20 import org
.eclipse
.swt
.widgets
.Label
;
21 import org
.eclipse
.swt
.widgets
.Listener
;
23 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTerm
;
24 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
25 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
26 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
27 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
28 import eu
.etaxonomy
.taxeditor
.preference
.IPreferenceKeys
;
29 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
30 import eu
.etaxonomy
.taxeditor
.preference
.Resources
;
31 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
32 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
33 import eu
.etaxonomy
.taxeditor
.store
.TermManager
;
34 import eu
.etaxonomy
.taxeditor
.ui
.element
.AbstractCdmFormElement
;
35 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmFormFactory
;
36 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmPropertyChangeEvent
;
37 import eu
.etaxonomy
.taxeditor
.ui
.element
.ICdmFormElement
;
38 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEnableableFormElement
;
39 import eu
.etaxonomy
.taxeditor
.ui
.element
.ISelectable
;
40 import eu
.etaxonomy
.taxeditor
.ui
.element
.LayoutConstants
;
44 * Abstract AbstractTermComboElement class.
48 * @created Nov 5, 2009
52 public class TermComboElement
<T
extends DefinedTermBase
>
53 extends AbstractCdmFormElement
implements SelectionListener
,
54 DisposeListener
, IEnableableFormElement
, ISelectable
{
56 private static final int DEFAULT_VISIBLE_ITEMS
= 10;
60 private T emptyElement
;
61 private static String EMPTY_ELEMENT_LABEL
= "";
63 protected Label label
;
64 private final Combo combo
;
66 private ArrayList
<T
> terms
;
68 private Comparator
<T
> termComparator
;
70 private final Class
<T
> termClass
;
72 private List
<T
> customPreferredTerms
;
74 private boolean addEmptyElement
;
76 public TermComboElement(CdmFormFactory formFactory
,
77 ICdmFormElement parentElement
, TermType termType
, String labelString
, T selection
, boolean addEmptyElement
,
79 this(formFactory
, parentElement
, null, termType
, null, labelString
, selection
, addEmptyElement
, style
);
82 public TermComboElement(CdmFormFactory formFactory
,
83 ICdmFormElement parentElement
, TermVocabulary
<?
> termVocabulary
, String labelString
, T selection
, boolean addEmptyElement
,
85 this(formFactory
, parentElement
, null, null, termVocabulary
, labelString
, selection
, addEmptyElement
, style
);
88 public TermComboElement(CdmFormFactory formFactory
,
89 ICdmFormElement parentElement
, Class
<T
> termClass
, String labelString
, T selection
, boolean addEmptyElement
,
91 this(formFactory
, parentElement
, termClass
, null, null, labelString
, selection
, addEmptyElement
, style
);
94 private TermComboElement(CdmFormFactory formFactory
,
95 ICdmFormElement parentElement
, Class
<T
> termClass
, TermType termType
, TermVocabulary
<?
> termVocabulary
, String labelString
, T selection
, boolean addEmptyElement
,
97 super(formFactory
, parentElement
);
100 this.termClass
= termClass
;
103 this.termClass
= (Class
<T
>) DefinedTerm
.class;
105 this.addEmptyElement
= addEmptyElement
;
107 if (labelString
!= null) {
108 label
= formFactory
.createLabel(getLayoutComposite(), labelString
);
113 combo
= new Combo(getLayoutComposite(), SWT
.BORDER
| SWT
.READ_ONLY
);//FIXME: removed this parameter seems break windows version: | style
115 combo
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
116 combo
.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS
);
119 //TODO try to remove generic T and avoid classes to be used
120 populateTerms((List
<T
>) getTermManager().getPreferredTerms(termType
));
122 else if(termVocabulary
!=null){
123 populateTerms((List
<T
>) getTermManager().getPreferredTerms(termVocabulary
));
125 else if(this.termClass
!=null){
126 populateTerms(getPreferredTerms());
129 combo
.addSelectionListener(this);
130 combo
.addDisposeListener(this);
131 PreferencesUtil
.getPreferenceStore().addPropertyChangeListener(this);
133 if (selection
!= null) {
134 setSelection(selection
);
140 * Getter for the field <code>selection</code>.
143 * @return a T object.
145 public T
getSelection() {
150 * <p>Sets the selection of the combo to the given T object.</p>
151 * <p>Passing <code>null</code> to this method will set the selection to
152 * the empty element and effectively clear the selection</p>
155 * a T object or <code>null</code> to clear the selection
157 public void setSelection(T selection
) {
158 this.selection
= selection
;
160 Listener
[] listeners
= combo
.getListeners(SWT
.Selection
);
162 for (Listener listener
: listeners
) {
163 combo
.removeListener(SWT
.Selection
, listener
);
166 if(selection
== null){
167 // set selection to the emptyElement
170 selectedIndex
= terms
.indexOf(selection
);
171 if (selectedIndex
== -1) {
172 createTermNotInPreferredTerms(selection
);
173 selectedIndex
= terms
.indexOf(selection
);
176 combo
.select(selectedIndex
);
178 for (Listener listener
: listeners
) {
179 combo
.addListener(SWT
.Selection
, listener
);
184 * Fills the combo with elements and sets up the convenience functions
185 * for selection index
187 * @param preferredTerms
189 private void populateTerms(List
<T
> preferredTerms
) {
193 terms
= new ArrayList
<T
>();
199 // Add an empty element for when nothing was selected yet
200 combo
.add(EMPTY_ELEMENT_LABEL
);
201 terms
.add(emptyElement
);
204 if (termComparator
!= null) {
205 Collections
.sort(preferredTerms
, termComparator
);
207 for (T term
: preferredTerms
) {
208 String label
= getLabel(term
);
210 if (term
.getTitleCache() != null) {
211 label
= term
.getTitleCache();
212 MessagingUtils
.warn(getClass(),
213 "Term does not have a default language representation: " + label
214 + ", " + term
.getUuid());
217 MessagingUtils
.warn(getClass(),
218 "Representation Label and TitleCache empty for term: "
219 + term
+ ", " + term
.getUuid());
228 if (selection
!= null) {
229 if (selection
.equals(term
)) {
235 if (selection
!= null && index
== 0) {
236 createTermNotInPreferredTerms(selection
);
244 * @see eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
248 public void setEnabled(boolean enabled
) {
249 combo
.setEnabled(enabled
);
253 * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#isEnabled()
256 public boolean isEnabled() {
257 return combo
.isEnabled();
265 * @return a {@link java.util.List} object.
267 protected List
<T
> getPreferredTerms(){
268 if (customPreferredTerms
!= null){
269 return customPreferredTerms
;
271 return getTermManager().getPreferredTerms(termClass
);
275 * May be overridden by derived classes if the desired label string does not
276 * reside in term.getLabel();
280 * @return a {@link java.lang.String} object.
282 protected String
getLabel(T term
) {
286 String termLabel
= term
.getLabel(CdmStore
.getDefaultLanguage());
287 if(PreferencesUtil
.getPreferenceStore().getBoolean(IPreferenceKeys
.SHOW_VOCABULARY_ID_FOR_TERM_LABELS
)
288 && term
.getVocabulary()!=null){
289 termLabel
+= " ["+term
.getVocabulary().getLabel(CdmStore
.getDefaultLanguage())+"]";
300 private void createTermNotInPreferredTerms(T term
) {
301 List
<T
> preferredTerms
= getPreferredTerms();
303 preferredTerms
.add(term
);
305 populateTerms(preferredTerms
);
310 * addSelectionListener
314 * a {@link org.eclipse.swt.events.SelectionListener} object.
316 public void addSelectionListener(SelectionListener listener
) {
317 combo
.addSelectionListener(listener
);
322 * removeSelectionListener
326 * a {@link org.eclipse.swt.events.SelectionListener} object.
328 public void removeSelectionListener(SelectionListener listener
) {
329 combo
.removeSelectionListener(listener
);
336 * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
337 * .events.SelectionEvent)
341 public void widgetSelected(SelectionEvent e
) {
342 selection
= terms
.get(combo
.getSelectionIndex());
343 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e
));
349 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.
350 * PropertyChangeEvent)
354 public void propertyChange(PropertyChangeEvent event
) {
355 super.propertyChange(event
);
357 && PreferencesUtil
.PREFERRED_TERMS_CHANGE
.equals(event
359 populateTerms(getPreferredTerms());
365 public void setSelected(boolean selected
) {
366 setBackground(selected ? SELECTED
: getPersistentBackground());
371 public void widgetDisposed(DisposeEvent e
) {
372 PreferencesUtil
.getPreferenceStore().removePropertyChangeListener(this);
378 public void widgetDefaultSelected(SelectionEvent e
) {
383 public void setIrrelevant(boolean irrelevant
) {
384 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
385 : Resources
.COLOR_COMPOSITE_BACKGROUND
;
387 Color color
= StoreUtil
.getColor(colorId
);
388 combo
.setBackground(color
);
393 public void setBackground(Color color
) {
395 label
.setBackground(color
);
402 protected TermManager
getTermManager() {
403 return CdmStore
.getTermManager();
410 public int getVisibleItemCount(){
411 return combo
.getVisibleItemCount();
418 public void setVisibleItemCount(int count
){
419 combo
.setVisibleItemCount(count
);
423 * <p>A {@link List} of term objects may be passed to this combo box. In this case, the default behaviour
424 * of displaying the preferred terms for the T type will be overridden and the combo will only display the
425 * given terms. Also, any previous selection will be reseted.</p>
427 * <p>To return to the default of displaying the preferred terms, simply pass <code>null</code>.</p>
429 * @param terms a {@link List} of T objects or <code>null</code> for default preferred terms
431 public void setTerms(List
<T
> terms
) {
433 customPreferredTerms
= terms
;
434 populateTerms(customPreferredTerms
);
437 public void removeEmptyElement(){
439 if(terms
.contains(emptyElement
)){
440 terms
.remove(emptyElement
);
442 if(Arrays
.asList(combo
.getItems()).contains(EMPTY_ELEMENT_LABEL
)){
443 combo
.remove(EMPTY_ELEMENT_LABEL
);