4 package eu
.etaxonomy
.taxeditor
.ui
.combo
;
6 import java
.util
.ArrayList
;
7 import java
.util
.Collections
;
8 import java
.util
.Comparator
;
11 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
12 import org
.eclipse
.swt
.SWT
;
13 import org
.eclipse
.swt
.events
.DisposeEvent
;
14 import org
.eclipse
.swt
.events
.DisposeListener
;
15 import org
.eclipse
.swt
.events
.SelectionEvent
;
16 import org
.eclipse
.swt
.events
.SelectionListener
;
17 import org
.eclipse
.swt
.graphics
.Color
;
18 import org
.eclipse
.swt
.widgets
.Combo
;
19 import org
.eclipse
.swt
.widgets
.Label
;
20 import org
.eclipse
.swt
.widgets
.Listener
;
22 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
23 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
24 import eu
.etaxonomy
.taxeditor
.preference
.Resources
;
25 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
26 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
27 import eu
.etaxonomy
.taxeditor
.store
.TermManager
;
28 import eu
.etaxonomy
.taxeditor
.ui
.forms
.AbstractCdmFormElement
;
29 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmFormFactory
;
30 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmPropertyChangeEvent
;
31 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ICdmFormElement
;
32 import eu
.etaxonomy
.taxeditor
.ui
.forms
.IEnableableFormElement
;
33 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ISelectable
;
37 * Abstract AbstractTermComboElement class.
41 * @created Nov 5, 2009
45 public class TermComboElement
<T
extends DefinedTermBase
>
46 extends AbstractCdmFormElement
implements SelectionListener
,
47 DisposeListener
, IEnableableFormElement
, ISelectable
{
49 private static final int DEFAULT_VISIBLE_ITEMS
= 10;
53 private T emptyElement
;
54 private static String EMPTY_ELEMENT_LABEL
= "";
56 protected Label label
;
59 private ArrayList
<T
> terms
;
61 private Comparator
<T
> termComparator
;
63 private Class
<T
> termClass
;
68 * Constructor for AbstractTermComboElement.
71 * @param parentElement
72 * a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement}
77 * a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory}
80 * a {@link java.lang.String} object.
88 public TermComboElement(CdmFormFactory formFactory
,
89 ICdmFormElement parentElement
, Class
<T
> termClass
, String labelString
, T selection
,
91 super(formFactory
, parentElement
);
93 this.termClass
= termClass
;
95 if (labelString
!= null) {
96 label
= formFactory
.createLabel(getLayoutComposite(), labelString
);
101 combo
= new Combo(getLayoutComposite(), SWT
.BORDER
| SWT
.READ_ONLY
);
103 combo
.setLayoutData(CdmFormFactory
.FILL_HORIZONTALLY());
104 combo
.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS
);
106 populateTerms(getPreferredTerms());
108 combo
.addSelectionListener(this);
109 combo
.addDisposeListener(this);
110 PreferencesUtil
.getPreferenceStore().addPropertyChangeListener(this);
112 if (selection
!= null) {
113 setSelection(selection
);
119 * Getter for the field <code>selection</code>.
122 * @return a T object.
124 public T
getSelection() {
130 * Setter for the field <code>selection</code>.
136 public void setSelection(T selection
) {
137 Listener
[] listeners
= combo
.getListeners(SWT
.Selection
);
139 for (Listener listener
: listeners
) {
140 combo
.removeListener(SWT
.Selection
, listener
);
143 int index
= terms
.indexOf(selection
);
145 createTermNotInPreferredTerms(selection
);
146 index
= terms
.indexOf(selection
);
150 for (Listener listener
: listeners
) {
151 combo
.addListener(SWT
.Selection
, listener
);
155 private void populateTerms(List
<T
> preferredTerms
) {
159 terms
= new ArrayList
<T
>();
164 // Add an empty element for when nothing was selected yet
165 combo
.add(EMPTY_ELEMENT_LABEL
);
166 terms
.add(emptyElement
);
168 if (termComparator
!= null) {
169 Collections
.sort(preferredTerms
, termComparator
);
171 for (T term
: preferredTerms
) {
172 String label
= getLabel(term
);
174 if (term
.getTitleCache() != null) {
175 label
= term
.getTitleCache();
176 StoreUtil
.error(getClass(),
177 "Term does not have a representation: " + term
178 + ", " + term
.getUuid(), null);
181 StoreUtil
.error(getClass(),
182 "Representation Label and TitleCache empty for term: "
183 + term
+ ", " + term
.getUuid(), null);
192 if (selection
!= null) {
193 if (selection
.equals(term
)) {
199 if (selection
!= null && index
== 0) {
200 createTermNotInPreferredTerms(selection
);
210 * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
213 public void setEnabled(boolean enabled
) {
214 combo
.setEnabled(enabled
);
222 * @return a {@link java.util.List} object.
224 protected List
<T
> getPreferredTerms(){
225 return getTermManager().getPreferredTerms(termClass
);
229 * May be overridden by derived classes if the desired label string does not
230 * reside in term.getLabel();
234 * @return a {@link java.lang.String} object.
236 protected String
getLabel(T term
) {
237 return term
.getLabel(CdmStore
.getDefaultLanguage());
240 private void createTermNotInPreferredTerms(T term
) {
241 List
<T
> preferredTerms
= getPreferredTerms();
243 preferredTerms
.add(term
);
245 populateTerms(preferredTerms
);
250 * addSelectionListener
254 * a {@link org.eclipse.swt.events.SelectionListener} object.
256 public void addSelectionListener(SelectionListener listener
) {
257 combo
.addSelectionListener(listener
);
262 * removeSelectionListener
266 * a {@link org.eclipse.swt.events.SelectionListener} object.
268 public void removeSelectionListener(SelectionListener listener
) {
269 combo
.removeSelectionListener(listener
);
276 * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
277 * .events.SelectionEvent)
280 public void widgetSelected(SelectionEvent e
) {
281 selection
= terms
.get(combo
.getSelectionIndex());
282 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e
));
288 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.
289 * PropertyChangeEvent)
292 public void propertyChange(PropertyChangeEvent event
) {
293 super.propertyChange(event
);
295 && PreferencesUtil
.PREFERRED_TERMS_CHANGE
.equals(event
297 populateTerms(getPreferredTerms());
302 public void setSelected(boolean selected
) {
303 setBackground(selected ? SELECTED
: getPersistentBackground());
307 public void widgetDisposed(DisposeEvent e
) {
308 PreferencesUtil
.getPreferenceStore().removePropertyChangeListener(this);
313 public void widgetDefaultSelected(SelectionEvent e
) {
317 public void setIrrelevant(boolean irrelevant
) {
318 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
319 : Resources
.COLOR_COMPOSITE_BACKGROUND
;
321 Color color
= StoreUtil
.getColor(colorId
);
322 combo
.setBackground(color
);
327 public void setBackground(Color color
) {
329 label
.setBackground(color
);
335 protected TermManager
getTermManager() {
336 return CdmStore
.getTermManager();
339 public int getVisibleItemCount(){
340 return combo
.getVisibleItemCount();
343 public void setVisibleItemCount(int count
){
344 combo
.setVisibleItemCount(count
);
347 public void setTerms(List
<T
> terms
) {
348 populateTerms(terms
);