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
.element
.AbstractCdmFormElement
;
29 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmFormFactory
;
30 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmPropertyChangeEvent
;
31 import eu
.etaxonomy
.taxeditor
.ui
.element
.ICdmFormElement
;
32 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEnableableFormElement
;
33 import eu
.etaxonomy
.taxeditor
.ui
.element
.ISelectable
;
34 import eu
.etaxonomy
.taxeditor
.ui
.element
.LayoutConstants
;
38 * Abstract AbstractTermComboElement class.
42 * @created Nov 5, 2009
46 public class TermComboElement
<T
extends DefinedTermBase
>
47 extends AbstractCdmFormElement
implements SelectionListener
,
48 DisposeListener
, IEnableableFormElement
, ISelectable
{
50 private static final int DEFAULT_VISIBLE_ITEMS
= 10;
54 private T emptyElement
;
55 private static String EMPTY_ELEMENT_LABEL
= "";
57 protected Label label
;
60 private ArrayList
<T
> terms
;
62 private Comparator
<T
> termComparator
;
64 private Class
<T
> termClass
;
66 private List
<T
> customPreferredTerms
;
71 * Constructor for AbstractTermComboElement.
74 * @param parentElement
75 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
80 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
83 * a {@link java.lang.String} object.
91 public TermComboElement(CdmFormFactory formFactory
,
92 ICdmFormElement parentElement
, Class
<T
> termClass
, String labelString
, T selection
,
94 super(formFactory
, parentElement
);
96 this.termClass
= termClass
;
98 if (labelString
!= null) {
99 label
= formFactory
.createLabel(getLayoutComposite(), labelString
);
104 combo
= new Combo(getLayoutComposite(), SWT
.BORDER
| SWT
.READ_ONLY
);
106 combo
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
107 combo
.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS
);
109 populateTerms(getPreferredTerms());
111 combo
.addSelectionListener(this);
112 combo
.addDisposeListener(this);
113 PreferencesUtil
.getPreferenceStore().addPropertyChangeListener(this);
115 if (selection
!= null) {
116 setSelection(selection
);
122 * Getter for the field <code>selection</code>.
125 * @return a T object.
127 public T
getSelection() {
132 * <p>Sets the selection of the combo to the given T object.</p>
133 * <p>Passing <code>null</code> to this method will set the selection to
134 * the empty element and effectively clear the selection</p>
137 * a T object or <code>null</code> to clear the selection
139 public void setSelection(T selection
) {
140 this.selection
= selection
;
142 this.selection
= selection
;
144 Listener
[] listeners
= combo
.getListeners(SWT
.Selection
);
146 for (Listener listener
: listeners
) {
147 combo
.removeListener(SWT
.Selection
, listener
);
150 if(selection
== null){
151 // set selection to the emptyElement
154 selectedIndex
= terms
.indexOf(selection
);
155 if (selectedIndex
== -1) {
156 createTermNotInPreferredTerms(selection
);
157 selectedIndex
= terms
.indexOf(selection
);
160 combo
.select(selectedIndex
);
162 for (Listener listener
: listeners
) {
163 combo
.addListener(SWT
.Selection
, listener
);
168 * Fills the combo with elements and sets up the convenience functions
169 * for selection index
171 * @param preferredTerms
173 private void populateTerms(List
<T
> preferredTerms
) {
177 terms
= new ArrayList
<T
>();
182 // Add an empty element for when nothing was selected yet
183 combo
.add(EMPTY_ELEMENT_LABEL
);
184 terms
.add(emptyElement
);
186 if (termComparator
!= null) {
187 Collections
.sort(preferredTerms
, termComparator
);
189 for (T term
: preferredTerms
) {
190 String label
= getLabel(term
);
192 if (term
.getTitleCache() != null) {
193 label
= term
.getTitleCache();
194 //StoreUtil.warn(getClass(),
195 // "Term does not have a representation: " + term
196 // + ", " + term.getUuid());
199 StoreUtil
.error(getClass(),
200 "Representation Label and TitleCache empty for term: "
201 + term
+ ", " + term
.getUuid(), null);
210 if (selection
!= null) {
211 if (selection
.equals(term
)) {
217 if (selection
!= null && index
== 0) {
218 createTermNotInPreferredTerms(selection
);
228 * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
231 public void setEnabled(boolean enabled
) {
232 combo
.setEnabled(enabled
);
240 * @return a {@link java.util.List} object.
242 protected List
<T
> getPreferredTerms(){
243 if (customPreferredTerms
!= null){
244 return customPreferredTerms
;
246 return getTermManager().getPreferredTerms(termClass
);
250 * May be overridden by derived classes if the desired label string does not
251 * reside in term.getLabel();
255 * @return a {@link java.lang.String} object.
257 protected String
getLabel(T term
) {
258 return term
.getLabel(CdmStore
.getDefaultLanguage());
266 private void createTermNotInPreferredTerms(T term
) {
267 List
<T
> preferredTerms
= getPreferredTerms();
269 preferredTerms
.add(term
);
271 populateTerms(preferredTerms
);
276 * addSelectionListener
280 * a {@link org.eclipse.swt.events.SelectionListener} object.
282 public void addSelectionListener(SelectionListener listener
) {
283 combo
.addSelectionListener(listener
);
288 * removeSelectionListener
292 * a {@link org.eclipse.swt.events.SelectionListener} object.
294 public void removeSelectionListener(SelectionListener listener
) {
295 combo
.removeSelectionListener(listener
);
302 * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
303 * .events.SelectionEvent)
306 public void widgetSelected(SelectionEvent e
) {
307 selection
= terms
.get(combo
.getSelectionIndex());
308 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e
));
314 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.
315 * PropertyChangeEvent)
318 public void propertyChange(PropertyChangeEvent event
) {
319 super.propertyChange(event
);
321 && PreferencesUtil
.PREFERRED_TERMS_CHANGE
.equals(event
323 populateTerms(getPreferredTerms());
328 public void setSelected(boolean selected
) {
329 setBackground(selected ? SELECTED
: getPersistentBackground());
333 public void widgetDisposed(DisposeEvent e
) {
334 PreferencesUtil
.getPreferenceStore().removePropertyChangeListener(this);
339 public void widgetDefaultSelected(SelectionEvent e
) {
343 public void setIrrelevant(boolean irrelevant
) {
344 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
345 : Resources
.COLOR_COMPOSITE_BACKGROUND
;
347 Color color
= StoreUtil
.getColor(colorId
);
348 combo
.setBackground(color
);
353 public void setBackground(Color color
) {
355 label
.setBackground(color
);
361 protected TermManager
getTermManager() {
362 return CdmStore
.getTermManager();
369 public int getVisibleItemCount(){
370 return combo
.getVisibleItemCount();
377 public void setVisibleItemCount(int count
){
378 combo
.setVisibleItemCount(count
);
382 * <p>A {@link List} of term objects may be passed to this combo box. In this case, the default behaviour
383 * of displaying the preferred terms for the T type will be overridden and the combo will only display the
384 * given terms. Also, any previous selection will be reseted.</p>
386 * <p>To return to the default of displaying the preferred terms, simply pass <code>null</code>.</p>
388 * @param terms a {@link List} of T objects or <code>null</code> for default preferred terms
390 public void setTerms(List
<T
> terms
) {
392 customPreferredTerms
= terms
;
393 populateTerms(customPreferredTerms
);