eu.etaxonomy.taxeditor.ui.combo

Class VocabularyComboElement<TERM extends eu.etaxonomy.cdm.model.common.DefinedTermBase<TERM>,VOC extends eu.etaxonomy.cdm.model.common.TermVocabulary<TERM>>

java.lang.Object

eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement

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

eu.etaxonomy.taxeditor.ui.combo.VocabularyComboElement<TERM,VOC>

Type Parameters:

VOC -

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

public class VocabularyComboElement<TERM extends eu.etaxonomy.cdm.model.common.DefinedTermBase<TERM>,VOC extends eu.etaxonomy.cdm.model.common.TermVocabulary<TERM>>
extends AbstractComboElement<VOC>

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
VocabularyComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, eu.etaxonomy.cdm.model.common.TermType termType, java.lang.String labelString, VOC selection, int style)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getLabel(VOC term) May be overridden by derived classes if the desired label string does not reside in term.getLabel();
protected TermManager	getTermManager()
int	getVisibleItemCount()
protected java.util.List<VOC>	getVocabularies()
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(VOC selection) Sets the selection of the combo to the given T object.
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

VocabularyComboElement

public VocabularyComboElement(CdmFormFactory formFactory,
                              ICdmFormElement parentElement,
                              eu.etaxonomy.cdm.model.common.TermType termType,
                              java.lang.String labelString,
                              VOC selection,
                              int style)

Method Detail

setSelection

public void setSelection(VOC 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<VOC extends eu.etaxonomy.cdm.model.common.TermVocabulary<TERM>>

Parameters:

selection - a T object or null to clear the selection

getVocabularies

protected java.util.List<VOC> getVocabularies()

getLabel

protected java.lang.String getLabel(VOC 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()

removeEmptyElement

public void removeEmptyElement()