eu.etaxonomy.taxeditor.ui.combo

Class TermComboElement<T extends eu.etaxonomy.cdm.model.common.DefinedTermBase>

java.lang.Object

eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement

eu.etaxonomy.taxeditor.ui.combo.AbstractComboElement<T>

eu.etaxonomy.taxeditor.ui.combo.TermComboElement<T>

Type Parameters:

T -

All Implemented Interfaces:

ICdmFormElement, IEnableableFormElement, IPropertyChangeEmitter, IRelevantFormElement, ISelectable, java.util.EventListener, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.swt.events.DisposeListener, org.eclipse.swt.events.SelectionListener, org.eclipse.swt.internal.SWTEventListener

Direct Known Subclasses:

MisappliedRelationshipComboElement

public class TermComboElement<T extends eu.etaxonomy.cdm.model.common.DefinedTermBase>
extends AbstractComboElement<T>

Version:

1.0

Author:

n.hoffmann

Field Summary

Fields inherited from class eu.etaxonomy.taxeditor.ui.combo.AbstractComboElement

combo, DEFAULT_VISIBLE_ITEMS, label, selection

Fields inherited from class eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement

formFactory

Fields inherited from interface eu.etaxonomy.taxeditor.ui.element.ISelectable

NOT_SELECTED, SELECTED

Constructor Summary

Constructors

Constructor and Description
TermComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, java.lang.Class<T> termClass, java.lang.String labelString, T selection, boolean addEmptyElement, int style)
TermComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, java.lang.Class<T> termClass, java.lang.String labelString, T selection, boolean addEmptyElement, int style, boolean useAbbrevLabel)
TermComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, eu.etaxonomy.cdm.model.common.TermType termType, java.lang.String labelString, T selection, boolean addEmptyElement, int style, boolean useAbbrevLabel, java.util.Comparator<T> comparator)
TermComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, eu.etaxonomy.cdm.model.common.TermVocabulary<?> termVocabulary, java.lang.String labelString, T selection, boolean addEmptyElement, int style, boolean useAbbrevLabel, java.util.Comparator<T> comparator)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getLabel(T term) May be overridden by derived classes if the desired label string does not reside in term.getLabel();
protected java.util.List<T>	getPreferredTerms()
java.util.Comparator<T>	getTermComparator()
protected TermManager	getTermManager()
int	getVisibleItemCount()
protected void	populateTerms(java.util.List<T> preferredTerms) Fills the combo with elements and sets up the convenience functions for selection index
void	propertyChange(org.eclipse.jface.util.PropertyChangeEvent event) This method gets called whenever the toolkit this composite was created with gets a property change notification.
void	removeEmptyElement()
void	setSelection(T selection) Sets the selection of the combo to the given T object.
void	setTermComparator(java.util.Comparator<T> termComparator)
void	setTerms(java.util.List<T> terms) A List of term objects may be passed to this combo box.
void	widgetSelected(org.eclipse.swt.events.SelectionEvent e)

Methods inherited from class eu.etaxonomy.taxeditor.ui.combo.AbstractComboElement

addSelectionListener, getSelection, isEnabled, removeSelectionListener, setBackground, setEnabled, setIrrelevant, setSelected, setVisibleItemCount, widgetDefaultSelected, widgetDisposed

Methods inherited from class eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement

addControl, addElement, containsFormElement, firePropertyChangeEvent, firePropertyChangeEvent, firePropertyChangeEvent, getColor, getControls, getElements, getFormFactory, getLayoutComposite, getParentElement, getPersistentBackground, getPropertyChangeListeners, refresh, removeControl, removeElement, removeElements, removeElementsAndControls, setFocus, setLayoutComposite, setPersistentBackground, setPropertyChangeListeners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TermComboElement

public TermComboElement(CdmFormFactory formFactory,
                        ICdmFormElement parentElement,
                        eu.etaxonomy.cdm.model.common.TermType termType,
                        java.lang.String labelString,
                        T selection,
                        boolean addEmptyElement,
                        int style,
                        boolean useAbbrevLabel,
                        java.util.Comparator<T> comparator)

TermComboElement

public TermComboElement(CdmFormFactory formFactory,
                        ICdmFormElement parentElement,
                        eu.etaxonomy.cdm.model.common.TermVocabulary<?> termVocabulary,
                        java.lang.String labelString,
                        T selection,
                        boolean addEmptyElement,
                        int style,
                        boolean useAbbrevLabel,
                        java.util.Comparator<T> comparator)

TermComboElement

public TermComboElement(CdmFormFactory formFactory,
                        ICdmFormElement parentElement,
                        java.lang.Class<T> termClass,
                        java.lang.String labelString,
                        T selection,
                        boolean addEmptyElement,
                        int style)

TermComboElement

public TermComboElement(CdmFormFactory formFactory,
                        ICdmFormElement parentElement,
                        java.lang.Class<T> termClass,
                        java.lang.String labelString,
                        T selection,
                        boolean addEmptyElement,
                        int style,
                        boolean useAbbrevLabel)

Method Detail

getTermComparator

public java.util.Comparator<T> getTermComparator()

setTermComparator

public void setTermComparator(java.util.Comparator<T> termComparator)

setSelection

public void setSelection(T selection)

Sets the selection of the combo to the given T object.

Passing null to this method will set the selection to the empty element and effectively clear the selection

Specified by:

setSelection in class AbstractComboElement<T extends eu.etaxonomy.cdm.model.common.DefinedTermBase>

Parameters:

selection - a T object or null to clear the selection

populateTerms

protected void populateTerms(java.util.List<T> preferredTerms)

Fills the combo with elements and sets up the convenience functions for selection index

Parameters:

preferredTerms -

getPreferredTerms

protected java.util.List<T> getPreferredTerms()

getLabel

protected java.lang.String getLabel(T term)

May be overridden by derived classes if the desired label string does not reside in term.getLabel();

Parameters:

term - a T object.

Returns:

a String object.

widgetSelected

public void widgetSelected(org.eclipse.swt.events.SelectionEvent e)

propertyChange

public void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)

This method gets called whenever the toolkit this composite was created with gets a property change notification. It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite. Implementations should also check for null PropertyChangeEvents and return immediately in that case.

Specified by:

propertyChange in interface org.eclipse.jface.util.IPropertyChangeListener

Overrides:

propertyChange in class AbstractCdmFormElement

See Also:

IPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)

getTermManager

protected TermManager getTermManager()

getVisibleItemCount

public int getVisibleItemCount()

setTerms

public void setTerms(java.util.List<T> terms)

A 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 given terms. Also, any previous selection will be reseted.

To return to the default of displaying the preferred terms, simply pass null.

Parameters:

terms - a List of T objects or null for default preferred terms

removeEmptyElement

public void removeEmptyElement()