3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
11 package eu
.etaxonomy
.taxeditor
.preference
.menu
;
13 import java
.util
.ArrayList
;
14 import java
.util
.HashMap
;
15 import java
.util
.List
;
17 import org
.eclipse
.core
.commands
.Command
;
18 import org
.eclipse
.core
.commands
.IParameter
;
19 import org
.eclipse
.core
.commands
.Parameterization
;
20 import org
.eclipse
.core
.commands
.ParameterizedCommand
;
21 import org
.eclipse
.core
.commands
.common
.NotDefinedException
;
22 import org
.eclipse
.core
.runtime
.IStatus
;
23 import org
.eclipse
.jface
.preference
.PreferencePage
;
24 import org
.eclipse
.jface
.viewers
.CheckStateChangedEvent
;
25 import org
.eclipse
.jface
.viewers
.CheckboxTableViewer
;
26 import org
.eclipse
.jface
.viewers
.ICheckStateListener
;
27 import org
.eclipse
.jface
.wizard
.WizardDialog
;
28 import org
.eclipse
.swt
.SWT
;
29 import org
.eclipse
.swt
.events
.SelectionAdapter
;
30 import org
.eclipse
.swt
.events
.SelectionEvent
;
31 import org
.eclipse
.swt
.layout
.GridData
;
32 import org
.eclipse
.swt
.layout
.GridLayout
;
33 import org
.eclipse
.swt
.widgets
.Button
;
34 import org
.eclipse
.swt
.widgets
.Composite
;
35 import org
.eclipse
.swt
.widgets
.Control
;
36 import org
.eclipse
.ui
.IWorkbench
;
37 import org
.eclipse
.ui
.IWorkbenchPreferencePage
;
38 import org
.eclipse
.ui
.commands
.ICommandService
;
39 import org
.eclipse
.ui
.handlers
.IHandlerService
;
41 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
42 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
43 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
44 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
45 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
46 import eu
.etaxonomy
.taxeditor
.editor
.definedterm
.DefinedTermEditor
;
47 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
48 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
49 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
50 import eu
.etaxonomy
.taxeditor
.preference
.wizard
.VocabularyTermWizard
;
51 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
52 import eu
.etaxonomy
.taxeditor
.store
.TermStore
;
55 * <p>Abstract AbstractMenuPreferences class.</p>
61 public abstract class AbstractMenuPreferences
<T
extends DefinedTermBase
> extends PreferencePage
implements
62 IWorkbenchPreferencePage
, IConversationEnabled
{
64 private Button toggleButton
;
65 protected HashMap
<DefinedTermBase
<T
>, Button
> menuButtons
;
67 protected Button newButton
;
68 protected Button editButton
;
69 protected Button removeButton
;
71 protected CheckboxTableViewer tableViewer
;
73 private boolean state
= true;
74 private final boolean vocabularyIsEditable
;
75 private ConversationHolder conversation
;
78 * Constructs a new menu preference page.
80 * @param initialVocabulary
81 * the initial vocabulary containing all possible entries for the menu
83 * the title of the page
85 * describing text for the preference page
87 * whether this vocabulary should be editable. Will render "New", "Edit", "Delete" buttons
88 * Handler for these buttons have to be overriding addEditButtonListeners()
89 * @param <T> a T object.
91 public AbstractMenuPreferences(String title
, String description
, boolean editable
) {
93 vocabularyIsEditable
= editable
;
94 setDescription(description
);
97 protected List
<T
> getTerms(){
98 return TermStore
.getTerms(getTermClass());
104 * Create contents of the preference page
107 public Control
createContents(Composite parent
) {
109 Composite container
= new Composite(parent
, SWT
.NULL
);
110 final GridLayout gridLayout
= new GridLayout();
111 gridLayout
.numColumns
= 2;
112 container
.setLayout(gridLayout
);
114 tableViewer
= CheckboxTableViewer
.newCheckList(container
, SWT
.NULL
);
115 GridData tableLayoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, false);
116 tableLayoutData
.heightHint
= 300;
117 tableViewer
.getTable().setLayoutData(tableLayoutData
);
119 tableViewer
.setContentProvider(new DefinedTermBaseContentProvider());
120 tableViewer
.setLabelProvider(new DefinedTermBaseLabelProvider());
124 tableViewer
.addCheckStateListener(new ICheckStateListener() {
127 public void checkStateChanged(CheckStateChangedEvent arg0
) {
132 Composite buttonContainer
= new Composite(container
, SWT
.NULL
);
133 GridData buttonContainerLayoutData
= new GridData();
134 buttonContainerLayoutData
.verticalAlignment
= SWT
.TOP
;
135 buttonContainer
.setLayoutData(buttonContainerLayoutData
);
136 buttonContainer
.setLayout(new GridLayout());
138 if(vocabularyIsEditable
) {
139 createEditButtons(buttonContainer
);
142 toggleButton
= new Button(buttonContainer
, SWT
.PUSH
);
143 toggleButton
.setText("Toggle");
144 toggleButton
.addSelectionListener(new SelectionAdapter(){
146 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
149 public void widgetSelected(SelectionEvent e
) {
150 state
= state ?
false : true;
151 tableViewer
.setAllChecked(state
);
156 createAdditionalContent(container
);
165 * @param definedTerms a {@link java.util.List} object.
167 protected void refresh(List
<T
> definedTerms
) {
168 tableViewer
.setInput(definedTerms
);
170 List
<T
> preferedTerms
= CdmStore
.getTermManager().getFilteredTerms(definedTerms
);
171 tableViewer
.setCheckedElements(preferedTerms
.toArray());
175 * <p>createAdditionalContent</p>
177 * @param container a {@link org.eclipse.swt.widgets.Composite} object.
179 protected void createAdditionalContent(Composite container
) {
180 // implement where needed
184 * @see eu.etaxonomy.taxeditor.preference.AbstractMenuPreferences#createButtons(org.eclipse.swt.widgets.Composite)
187 * <p>createEditButtons</p>
189 * @param buttonContainer a {@link org.eclipse.swt.widgets.Composite} object.
191 protected void createEditButtons(Composite buttonContainer
) {
193 editButton
= new Button(buttonContainer
, SWT
.PUSH
);
194 editButton
.setText("Open Term Editor");
195 editButton
.setLayoutData(new GridData(SWT
.FILL
));
197 addEditButtonListeners();
201 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
204 protected void addNewButtonListeners() {
205 newButton
.addSelectionListener(new SelectionAdapter(){
207 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
210 public void widgetSelected(SelectionEvent e
) {
211 VocabularyTermWizard
<T
> wizard
= new VocabularyTermWizard
<T
>(getTermClass(), getConversationHolder());
213 WizardDialog dialog
= new WizardDialog(AbstractUtility
.getShell(), wizard
);
214 if(dialog
.open() == IStatus
.OK
){
215 tableViewer
.setInput(getTerms());
224 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
227 protected void addEditButtonListeners() {
228 editButton
.addSelectionListener(new SelectionAdapter(){
230 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
233 public void widgetSelected(SelectionEvent event
) {
235 ICommandService commandService
= (ICommandService
) AbstractUtility
.getService(ICommandService
.class);
237 Command command
= commandService
.getCommand(DefinedTermEditor
.OPEN_COMMAND_ID
);
239 IParameter parameter
;
241 parameter
= command
.getParameter("eu.etaxonomy.taxeditor.store.openDefinedTermEditor.termTypeUuid");
243 Parameterization
[] parameterizations
= new Parameterization
[]{
244 new Parameterization(parameter
, TermType
.valueOf(getTermClass().getSimpleName()).getUuid().toString())
247 ParameterizedCommand pCommand
= new ParameterizedCommand(command
, parameterizations
);
249 if (command
.isEnabled()) {
250 IHandlerService handlerService
= (IHandlerService
) AbstractUtility
.getService(IHandlerService
.class);
252 handlerService
.executeCommand(pCommand
, null);
253 } catch (NotDefinedException e
) {
254 throw new RuntimeException("Could not find open command: "
255 + DefinedTermEditor
.OPEN_COMMAND_ID
);
256 } catch (Exception e
) {
259 "An exception occured while trying to open a selection",
263 } catch (NotDefinedException e
) {
266 "An exception occured while trying to open the Term Editor",
276 public void init(IWorkbench workbench
) {
277 setPreferenceStore(PreferencesUtil
.getPreferenceStore());
278 getConversationHolder().bind();
283 * @see org.eclipse.jface.preference.PreferencePage#performDefaults()
286 * <p>performDefaults</p>
289 protected void performDefaults() {
290 tableViewer
.setAllChecked(true);
294 * <p>Getter for the field <code>tableViewer</code>.</p>
296 * @return the tableViewer
298 public CheckboxTableViewer
getTableViewer() {
303 * @see org.eclipse.jface.preference.PreferencePage#performOk()
307 public boolean performOk() {
308 if(checkNoneChecked()){
312 getConversationHolder().commit(true);
314 List
<T
> preferredTerms
= new ArrayList
<T
>();
315 for (Object element
: getTableViewer().getCheckedElements()){
316 preferredTerms
.add((T
) element
);
319 CdmStore
.getTermManager().setPreferredTerms(preferredTerms
, getTerms());
321 PreferencesUtil
.firePreferencesChanged(this.getClass());
326 private boolean checkNoneChecked(){
328 if(tableViewer
.getCheckedElements().length
== 0){
329 setMessage("Please check at least one item", WARNING
);
338 * <p>getTermClass</p>
340 * @return a {@link java.lang.Class} object.
342 protected abstract Class
<T
> getTermClass();
345 * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
348 public ConversationHolder
getConversationHolder() {
349 if(conversation
== null){
350 conversation
= CdmStore
.createConversation();
356 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
359 public void update(CdmDataChangeMap changeEvents
) {
360 // implement where needed