eu.etaxonomy.taxeditor.preference.menu

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

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.preference.PreferencePage

eu.etaxonomy.taxeditor.preference.menu.CdmPreferencePage

eu.etaxonomy.taxeditor.preference.menu.AbstractMenuPreferences<T>

All Implemented Interfaces:

eu.etaxonomy.cdm.api.conversation.IConversationEnabled, eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver, IE4PreferencePage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage

Direct Known Subclasses:

ExtensionTypeMenuPreferences, FeatureMenuPreferences, LanguageMenuPreferences, MarkerTypeMenuPreferences, MeasurementUnitMenuPreferences, NamedAreaTypeMenuPreferences, NameRelationshipTypeMenuPreferences, NameTypeDesignationStatusMenuPreferences, NomenclaturalStatusTypeMenuPreferences, PresenceAbsenceMenuPreferences, PreservationMethodMenuPreferences, RankMenuPreferences, SpecimenTypeDesignationStatusMenuPreferences, StageMenuPreferences, TaxonRelationshipTypeMenuPreferences

public abstract class AbstractMenuPreferences<T extends eu.etaxonomy.cdm.model.common.DefinedTermBase>
extends CdmPreferencePage
implements eu.etaxonomy.cdm.api.conversation.IConversationEnabled

Version:

1.0

Author:

n.hoffmann

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Button	editButton
protected java.util.HashMap<eu.etaxonomy.cdm.model.common.DefinedTermBase<T>,org.eclipse.swt.widgets.Button>	menuButtons
protected org.eclipse.swt.widgets.Button	removeButton
protected org.eclipse.jface.viewers.CheckboxTableViewer	tableViewer

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
AbstractMenuPreferences(java.lang.String title, java.lang.String description, boolean editable) Constructs a new menu preference page.

Method Summary

Modifier and Type	Method and Description
protected void	addEditButtonListeners() Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag is set.
protected void	createAdditionalContent(org.eclipse.swt.widgets.Composite container)
org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent) Create contents of the preference page
protected void	createEditButtons(org.eclipse.swt.widgets.Composite buttonContainer)
eu.etaxonomy.cdm.api.conversation.ConversationHolder	getConversationHolder()
protected java.util.List<T>	getTerms()
protected abstract eu.etaxonomy.cdm.model.common.TermType	getTermType()
void	init()
protected void	performDefaults() performDefaults
boolean	performOk()
protected void	refresh(java.util.List<T> definedTerms)
void	update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap changeEvents)

Methods inherited from class eu.etaxonomy.taxeditor.preference.menu.CdmPreferencePage

performApply, performCancel

Methods inherited from class org.eclipse.jface.preference.PreferencePage

applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, noDefaultButton, okToLeave, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

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

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, setDescription, setImageDescriptor, setVisible

Field Detail

menuButtons

protected java.util.HashMap<eu.etaxonomy.cdm.model.common.DefinedTermBase<T extends eu.etaxonomy.cdm.model.common.DefinedTermBase>,org.eclipse.swt.widgets.Button> menuButtons

editButton

protected org.eclipse.swt.widgets.Button editButton

removeButton

protected org.eclipse.swt.widgets.Button removeButton

tableViewer

protected org.eclipse.jface.viewers.CheckboxTableViewer tableViewer

Constructor Detail

AbstractMenuPreferences

public AbstractMenuPreferences(java.lang.String title,
                               java.lang.String description,
                               boolean editable)

Constructs a new menu preference page.

Type Parameters:

T - a T object.

Parameters:

initialVocabulary - the initial vocabulary containing all possible entries for the menu

title - the title of the page

description - describing text for the preference page

editable - whether this vocabulary should be editable. Will render "New", "Edit", "Delete" buttons Handler for these buttons have to be overriding addEditButtonListeners()

Method Detail

getTerms

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

createContents

public org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)

Create contents of the preference page

Specified by:

createContents in class org.eclipse.jface.preference.PreferencePage

refresh

protected void refresh(java.util.List<T> definedTerms)

createAdditionalContent

protected void createAdditionalContent(org.eclipse.swt.widgets.Composite container)

createEditButtons

protected void createEditButtons(org.eclipse.swt.widgets.Composite buttonContainer)

addEditButtonListeners

protected void addEditButtonListeners()

Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag is set.

init

public void init()

Overrides:

init in class CdmPreferencePage

performDefaults

protected void performDefaults()

performDefaults

Overrides:

performDefaults in class org.eclipse.jface.preference.PreferencePage

performOk

public boolean performOk()

Specified by:

performOk in interface org.eclipse.jface.preference.IPreferencePage

Overrides:

performOk in class CdmPreferencePage

getTermType

protected abstract eu.etaxonomy.cdm.model.common.TermType getTermType()

getConversationHolder

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

Specified by:

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

update

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

Specified by:

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