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
;
69 * Constructor for AbstractTermComboElement.
72 * @param parentElement
73 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
78 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
81 * a {@link java.lang.String} object.
89 public TermComboElement(CdmFormFactory formFactory
,
90 ICdmFormElement parentElement
, Class
<T
> termClass
, String labelString
, T selection
,
92 super(formFactory
, parentElement
);
94 this.termClass
= termClass
;
96 if (labelString
!= null) {
97 label
= formFactory
.createLabel(getLayoutComposite(), labelString
);
102 combo
= new Combo(getLayoutComposite(), SWT
.BORDER
| SWT
.READ_ONLY
);
104 combo
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
105 combo
.setVisibleItemCount(DEFAULT_VISIBLE_ITEMS
);
107 populateTerms(getPreferredTerms());
109 combo
.addSelectionListener(this);
110 combo
.addDisposeListener(this);
111 PreferencesUtil
.getPreferenceStore().addPropertyChangeListener(this);
113 if (selection
!= null) {
114 setSelection(selection
);
120 * Getter for the field <code>selection</code>.
123 * @return a T object.
125 public T
getSelection() {
131 * Setter for the field <code>selection</code>.
137 public void setSelection(T selection
) {
138 Listener
[] listeners
= combo
.getListeners(SWT
.Selection
);
140 for (Listener listener
: listeners
) {
141 combo
.removeListener(SWT
.Selection
, listener
);
144 int index
= terms
.indexOf(selection
);
146 createTermNotInPreferredTerms(selection
);
147 index
= terms
.indexOf(selection
);
151 for (Listener listener
: listeners
) {
152 combo
.addListener(SWT
.Selection
, listener
);
156 private void populateTerms(List
<T
> preferredTerms
) {
160 terms
= new ArrayList
<T
>();
165 // Add an empty element for when nothing was selected yet
166 combo
.add(EMPTY_ELEMENT_LABEL
);
167 terms
.add(emptyElement
);
169 if (termComparator
!= null) {
170 Collections
.sort(preferredTerms
, termComparator
);
172 for (T term
: preferredTerms
) {
173 String label
= getLabel(term
);
175 if (term
.getTitleCache() != null) {
176 label
= term
.getTitleCache();
177 StoreUtil
.error(getClass(),
178 "Term does not have a representation: " + term
179 + ", " + term
.getUuid(), null);
182 StoreUtil
.error(getClass(),
183 "Representation Label and TitleCache empty for term: "
184 + term
+ ", " + term
.getUuid(), null);
193 if (selection
!= null) {
194 if (selection
.equals(term
)) {
200 if (selection
!= null && index
== 0) {
201 createTermNotInPreferredTerms(selection
);
211 * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
214 public void setEnabled(boolean enabled
) {
215 combo
.setEnabled(enabled
);
223 * @return a {@link java.util.List} object.
225 protected List
<T
> getPreferredTerms(){
226 return getTermManager().getPreferredTerms(termClass
);
230 * May be overridden by derived classes if the desired label string does not
231 * reside in term.getLabel();
235 * @return a {@link java.lang.String} object.
237 protected String
getLabel(T term
) {
238 return term
.getLabel(CdmStore
.getDefaultLanguage());
241 private void createTermNotInPreferredTerms(T term
) {
242 List
<T
> preferredTerms
= getPreferredTerms();
244 preferredTerms
.add(term
);
246 populateTerms(preferredTerms
);
251 * addSelectionListener
255 * a {@link org.eclipse.swt.events.SelectionListener} object.
257 public void addSelectionListener(SelectionListener listener
) {
258 combo
.addSelectionListener(listener
);
263 * removeSelectionListener
267 * a {@link org.eclipse.swt.events.SelectionListener} object.
269 public void removeSelectionListener(SelectionListener listener
) {
270 combo
.removeSelectionListener(listener
);
277 * org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt
278 * .events.SelectionEvent)
281 public void widgetSelected(SelectionEvent e
) {
282 selection
= terms
.get(combo
.getSelectionIndex());
283 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e
));
289 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.
290 * PropertyChangeEvent)
293 public void propertyChange(PropertyChangeEvent event
) {
294 super.propertyChange(event
);
296 && PreferencesUtil
.PREFERRED_TERMS_CHANGE
.equals(event
298 populateTerms(getPreferredTerms());
303 public void setSelected(boolean selected
) {
304 setBackground(selected ? SELECTED
: getPersistentBackground());
308 public void widgetDisposed(DisposeEvent e
) {
309 PreferencesUtil
.getPreferenceStore().removePropertyChangeListener(this);
314 public void widgetDefaultSelected(SelectionEvent e
) {
318 public void setIrrelevant(boolean irrelevant
) {
319 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
320 : Resources
.COLOR_COMPOSITE_BACKGROUND
;
322 Color color
= StoreUtil
.getColor(colorId
);
323 combo
.setBackground(color
);
328 public void setBackground(Color color
) {
330 label
.setBackground(color
);
336 protected TermManager
getTermManager() {
337 return CdmStore
.getTermManager();
340 public int getVisibleItemCount(){
341 return combo
.getVisibleItemCount();
344 public void setVisibleItemCount(int count
){
345 combo
.setVisibleItemCount(count
);
348 public void setTerms(List
<T
> terms
) {
349 populateTerms(terms
);