eu.etaxonomy.taxeditor.ui.dialog.selection

Class AbstractFilteredCdmEnumSelectionDialog<T extends eu.etaxonomy.cdm.model.common.IEnumTerm>

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

org.eclipse.ui.dialogs.SelectionDialog

org.eclipse.ui.dialogs.SelectionStatusDialog

org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

eu.etaxonomy.taxeditor.ui.dialog.selection.AbstractFilteredCdmEnumSelectionDialog<T>

All Implemented Interfaces:

eu.etaxonomy.cdm.api.conversation.IConversationEnabled, eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver, org.eclipse.jface.window.IShellProvider

Direct Known Subclasses:

OriginalSourceTypeSelectionDialog, SpecimenOrObservationTypeSelectionDialog

public abstract class AbstractFilteredCdmEnumSelectionDialog<T extends eu.etaxonomy.cdm.model.common.IEnumTerm>
extends org.eclipse.ui.dialogs.FilteredItemsSelectionDialog
implements eu.etaxonomy.cdm.api.conversation.IConversationEnabled

Abstract AbstractFilteredCdmEnumSelectionDialog class.

Version:

1.0

Author:

c.mathew

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractFilteredCdmEnumSelectionDialog.FilteredCdmResourceLabelProvider

Nested classes/interfaces inherited from class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<T>	model

Fields inherited from class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

CARET_BEGINNING, FULL_SELECTION, NONE

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK, resizeHasOccurred

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilteredCdmEnumSelectionDialog(org.eclipse.swt.widgets.Shell shell, eu.etaxonomy.cdm.api.conversation.ConversationHolder conversation, java.lang.String title, boolean multi, java.lang.String settings, T cdmEnum) Constructor for AbstractFilteredCdmResourceSelectionDialog.

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.jface.viewers.ILabelProvider	createDetailsLabelProvider() By default, we are returning the standard list label provider Override in subclasses if you want different behavior
protected org.eclipse.swt.widgets.Control	createExtendedContentArea(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter	createFilter()
protected org.eclipse.jface.viewers.ILabelProvider	createListLabelProvider()
protected void	fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider contentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter itemsFilter, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
eu.etaxonomy.cdm.api.conversation.ConversationHolder	getConversationHolder() getConversationHolder
protected org.eclipse.jface.dialogs.IDialogSettings	getDialogSettings()
java.lang.String	getElementName(java.lang.Object item)
protected java.util.Comparator	getItemsComparator()
protected abstract AbstractNewEntityWizard	getNewEntityWizard(java.lang.String parameter) getNewEntityWizard
protected org.eclipse.swt.events.SelectionListener	getNewWizardLinkSelectionListener()
protected abstract java.lang.String	getNewWizardLinkText() getNewWizardLinkText
protected T	getSelectedEnumTerm() getSelectedUuidAndTitleCache
protected static <TYPE extends eu.etaxonomy.cdm.model.common.IEnumTerm> TYPE	getSelectionFromDialog(AbstractFilteredCdmEnumSelectionDialog<TYPE> dialog) getSelectionFromDialog
java.lang.String	getSettings() Getter for the field settings.
protected java.lang.String	getTitle(T cdmEnum) getTitle
protected void	init() Override in subclasses.
protected abstract void	initModel() initModel
void	refresh()
protected void	setPattern(T cdmObject) Set the filter input to the Agent's title cache
void	update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap changeEvents)
protected org.eclipse.core.runtime.IStatus	validateItem(java.lang.Object item)

Methods inherited from class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

accessedHistoryItem, addListFilter, applyFilter, close, computeResult, create, createDialogArea, fillContextMenu, fillViewMenu, getDialogBoundsSettings, getInitialPattern, getPatternControl, getSelectedItems, getSelectionHistory, handleDoubleClick, handleSelected, isDuplicateElement, isHistoryElement, okPressed, reloadCache, removeHistoryItem, restoreDialog, scheduleProgressMessageRefresh, scheduleRefresh, setDetailsLabelProvider, setInitialPattern, setInitialPattern, setListLabelProvider, setListSelectionLabelDecorator, setSelectionHistory, setSeparatorLabel, storeDialog, updateProgressLabel, updateStatus

Methods inherited from class org.eclipse.ui.dialogs.SelectionStatusDialog

configureShell, createButtonBar, getFirstResult, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState

Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog

createButtonsForButtonBar, createMessageArea, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

closeTray, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

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

Field Detail

model

protected java.util.List<T extends eu.etaxonomy.cdm.model.common.IEnumTerm> model

Constructor Detail

AbstractFilteredCdmEnumSelectionDialog

protected AbstractFilteredCdmEnumSelectionDialog(org.eclipse.swt.widgets.Shell shell,
                                                 eu.etaxonomy.cdm.api.conversation.ConversationHolder conversation,
                                                 java.lang.String title,
                                                 boolean multi,
                                                 java.lang.String settings,
                                                 T cdmEnum)

Constructor for AbstractFilteredCdmResourceSelectionDialog.

Type Parameters:

T - a T object.

Parameters:

shell - a Shell object.

conversation -

title - a String object.

multi - a boolean.

settings - a String object.

cdmEnum - a T object.

Method Detail

createDetailsLabelProvider

protected org.eclipse.jface.viewers.ILabelProvider createDetailsLabelProvider()

By default, we are returning the standard list label provider Override in subclasses if you want different behavior

Returns:

createListLabelProvider

protected org.eclipse.jface.viewers.ILabelProvider createListLabelProvider()

Returns:

init

protected void init()

Override in subclasses. Will run before initModel()

getSelectionFromDialog

protected static <TYPE extends eu.etaxonomy.cdm.model.common.IEnumTerm> TYPE getSelectionFromDialog(AbstractFilteredCdmEnumSelectionDialog<TYPE> dialog)

getSelectionFromDialog

Type Parameters:

TYPE - a TYPE object.

Parameters:

dialog - a AbstractFilteredCdmResourceSelectionDialog object.

Returns:

a TYPE object.

getTitle

protected java.lang.String getTitle(T cdmEnum)

getTitle

Parameters:

cdmObject - a T object.

Returns:

a String object.

refresh

public void refresh()

Overrides:

refresh in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

initModel

protected abstract void initModel()

initModel

createFilter

protected org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter createFilter()

Specified by:

createFilter in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

setPattern

protected void setPattern(T cdmObject)

Set the filter input to the Agent's title cache

Parameters:

cdmObject - a T object.

fillContentProvider

protected void fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider contentProvider,
                                   org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter itemsFilter,
                                   org.eclipse.core.runtime.IProgressMonitor progressMonitor)
                            throws org.eclipse.core.runtime.CoreException

Specified by:

fillContentProvider in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

Throws:

org.eclipse.core.runtime.CoreException

getDialogSettings

protected org.eclipse.jface.dialogs.IDialogSettings getDialogSettings()

Specified by:

getDialogSettings in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

getElementName

public java.lang.String getElementName(java.lang.Object item)

Specified by:

getElementName in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

getItemsComparator

protected java.util.Comparator getItemsComparator()

Specified by:

getItemsComparator in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

validateItem

protected org.eclipse.core.runtime.IStatus validateItem(java.lang.Object item)

Specified by:

validateItem in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

getSelectedEnumTerm

protected T getSelectedEnumTerm()

getSelectedUuidAndTitleCache

Returns:

a eu.etaxonomy.cdm.model.common.UuidAndTitleCache object.

getSettings

public java.lang.String getSettings()

Getter for the field settings.

Returns:

a String object.

getNewWizardLinkText

protected abstract java.lang.String getNewWizardLinkText()

getNewWizardLinkText

Returns:

a String object.

getNewEntityWizard

protected abstract AbstractNewEntityWizard getNewEntityWizard(java.lang.String parameter)

getNewEntityWizard

Parameters:

parameter -

Returns:

a AbstractNewEntityWizard object.

createExtendedContentArea

protected org.eclipse.swt.widgets.Control createExtendedContentArea(org.eclipse.swt.widgets.Composite parent)

Specified by:

createExtendedContentArea in class org.eclipse.ui.dialogs.FilteredItemsSelectionDialog

getNewWizardLinkSelectionListener

protected org.eclipse.swt.events.SelectionListener getNewWizardLinkSelectionListener()

getConversationHolder

public eu.etaxonomy.cdm.api.conversation.ConversationHolder getConversationHolder()

getConversationHolder

Specified by:

getConversationHolder in interface eu.etaxonomy.cdm.api.conversation.IConversationEnabled

Returns:

a ConversationHolder object.

update

public void update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap changeEvents)

Specified by:

update in interface eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver