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
.viewers
.CheckStateChangedEvent
;
24 import org
.eclipse
.jface
.viewers
.CheckboxTableViewer
;
25 import org
.eclipse
.jface
.viewers
.ICheckStateListener
;
26 import org
.eclipse
.jface
.wizard
.WizardDialog
;
27 import org
.eclipse
.swt
.SWT
;
28 import org
.eclipse
.swt
.events
.SelectionAdapter
;
29 import org
.eclipse
.swt
.events
.SelectionEvent
;
30 import org
.eclipse
.swt
.layout
.GridData
;
31 import org
.eclipse
.swt
.layout
.GridLayout
;
32 import org
.eclipse
.swt
.widgets
.Button
;
33 import org
.eclipse
.swt
.widgets
.Composite
;
34 import org
.eclipse
.swt
.widgets
.Control
;
35 import org
.eclipse
.ui
.IWorkbench
;
36 import org
.eclipse
.ui
.IWorkbenchPreferencePage
;
37 import org
.eclipse
.ui
.commands
.ICommandService
;
38 import org
.eclipse
.ui
.handlers
.IHandlerService
;
40 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
41 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
42 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
43 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
44 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
45 import eu
.etaxonomy
.taxeditor
.editor
.definedterm
.DefinedTermEditor
;
46 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
47 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
48 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
49 import eu
.etaxonomy
.taxeditor
.preference
.wizard
.VocabularyTermWizard
;
50 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
51 import eu
.etaxonomy
.taxeditor
.store
.TermStore
;
58 public abstract class AbstractMenuPreferences
<T
extends DefinedTermBase
> extends CdmPreferencePage
implements
59 IWorkbenchPreferencePage
, IConversationEnabled
{
61 private Button toggleButton
;
62 protected HashMap
<DefinedTermBase
<T
>, Button
> menuButtons
;
64 protected Button newButton
;
65 protected Button editButton
;
66 protected Button removeButton
;
68 protected CheckboxTableViewer tableViewer
;
70 private boolean state
= true;
71 private final boolean vocabularyIsEditable
;
72 private ConversationHolder conversation
;
75 * Constructs a new menu preference page.
77 * @param initialVocabulary
78 * the initial vocabulary containing all possible entries for the menu
80 * the title of the page
82 * describing text for the preference page
84 * whether this vocabulary should be editable. Will render "New", "Edit", "Delete" buttons
85 * Handler for these buttons have to be overriding addEditButtonListeners()
86 * @param <T> a T object.
88 public AbstractMenuPreferences(String title
, String description
, boolean editable
) {
90 vocabularyIsEditable
= editable
;
91 setDescription(description
);
94 protected List
<T
> getTerms(){
95 if(!CdmStore
.isActive()) {
96 return new ArrayList
<T
>();
98 return TermStore
.getTerms(getTermClass());
105 * Create contents of the preference page
108 public Control
createContents(Composite parent
) {
110 Composite container
= new Composite(parent
, SWT
.NULL
);
111 final GridLayout gridLayout
= new GridLayout();
112 gridLayout
.numColumns
= 2;
113 container
.setLayout(gridLayout
);
115 tableViewer
= CheckboxTableViewer
.newCheckList(container
, SWT
.NULL
);
116 GridData tableLayoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, false);
117 tableLayoutData
.heightHint
= 300;
118 tableViewer
.getTable().setLayoutData(tableLayoutData
);
120 tableViewer
.setContentProvider(new DefinedTermBaseContentProvider());
121 tableViewer
.setLabelProvider(new DefinedTermBaseLabelProvider());
125 tableViewer
.addCheckStateListener(new ICheckStateListener() {
128 public void checkStateChanged(CheckStateChangedEvent arg0
) {
133 Composite buttonContainer
= new Composite(container
, SWT
.NULL
);
134 GridData buttonContainerLayoutData
= new GridData();
135 buttonContainerLayoutData
.verticalAlignment
= SWT
.TOP
;
136 buttonContainer
.setLayoutData(buttonContainerLayoutData
);
137 buttonContainer
.setLayout(new GridLayout());
139 if(vocabularyIsEditable
) {
140 createEditButtons(buttonContainer
);
143 toggleButton
= new Button(buttonContainer
, SWT
.PUSH
);
144 toggleButton
.setText("Toggle");
145 toggleButton
.addSelectionListener(new SelectionAdapter(){
147 public void widgetSelected(SelectionEvent e
) {
148 state
= state ?
false : true;
149 tableViewer
.setAllChecked(state
);
154 createAdditionalContent(container
);
159 protected void refresh(List
<T
> definedTerms
) {
160 tableViewer
.setInput(definedTerms
);
162 List
<T
> preferedTerms
= CdmStore
.getTermManager().getFilteredTerms(definedTerms
);
163 tableViewer
.setCheckedElements(preferedTerms
.toArray());
166 protected void createAdditionalContent(Composite container
) {
167 // implement where needed
170 protected void createEditButtons(Composite buttonContainer
) {
172 editButton
= new Button(buttonContainer
, SWT
.PUSH
);
173 editButton
.setText("Open Term Editor");
174 editButton
.setLayoutData(new GridData(SWT
.FILL
));
176 addEditButtonListeners();
180 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
183 protected void addNewButtonListeners() {
184 newButton
.addSelectionListener(new SelectionAdapter(){
186 public void widgetSelected(SelectionEvent e
) {
187 VocabularyTermWizard
<T
> wizard
= new VocabularyTermWizard
<T
>(getTermClass(), getConversationHolder());
189 WizardDialog dialog
= new WizardDialog(AbstractUtility
.getShell(), wizard
);
190 if(dialog
.open() == IStatus
.OK
){
191 tableViewer
.setInput(getTerms());
199 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
202 protected void addEditButtonListeners() {
203 editButton
.addSelectionListener(new SelectionAdapter(){
205 public void widgetSelected(SelectionEvent event
) {
207 ICommandService commandService
= (ICommandService
) AbstractUtility
.getService(ICommandService
.class);
209 Command command
= commandService
.getCommand(DefinedTermEditor
.OPEN_COMMAND_ID
);
211 IParameter parameter
;
213 parameter
= command
.getParameter("eu.etaxonomy.taxeditor.store.openDefinedTermEditor.termTypeUuid");
215 Parameterization
[] parameterizations
= new Parameterization
[]{
216 new Parameterization(parameter
, TermType
.valueOf(getTermClass().getSimpleName()).getUuid().toString())
219 ParameterizedCommand pCommand
= new ParameterizedCommand(command
, parameterizations
);
221 if (command
.isEnabled()) {
222 IHandlerService handlerService
= (IHandlerService
) AbstractUtility
.getService(IHandlerService
.class);
224 handlerService
.executeCommand(pCommand
, null);
225 } catch (NotDefinedException e
) {
226 throw new RuntimeException("Could not find open command: "
227 + DefinedTermEditor
.OPEN_COMMAND_ID
);
228 } catch (Exception e
) {
231 "An exception occured while trying to open a selection",
235 } catch (NotDefinedException e
) {
238 "An exception occured while trying to open the Term Editor",
248 public void init(IWorkbench workbench
) {
249 setPreferenceStore(PreferencesUtil
.getPreferenceStore());
250 if(!CdmStore
.isActive()) {
251 MessagingUtils
.noDataSourceWarningDialog(null);
254 getConversationHolder().bind();
259 * <p>performDefaults</p>
262 protected void performDefaults() {
263 tableViewer
.setAllChecked(true);
266 public CheckboxTableViewer
getTableViewer() {
272 public boolean performOk() {
273 if(!CdmStore
.isActive()) {
277 if(checkNoneChecked()){
281 getConversationHolder().commit(true);
283 List
<T
> preferredTerms
= new ArrayList
<T
>();
284 for (Object element
: getTableViewer().getCheckedElements()){
285 preferredTerms
.add((T
) element
);
288 CdmStore
.getTermManager().setPreferredTerms(preferredTerms
, getTerms());
292 PreferencesUtil
.firePreferencesChanged(this.getClass());
295 return super.performOk();
298 private boolean checkNoneChecked(){
300 if(tableViewer
.getCheckedElements().length
== 0){
301 setMessage("Please check at least one item", WARNING
);
309 protected abstract Class
<T
> getTermClass();
312 public ConversationHolder
getConversationHolder() {
313 if(conversation
== null){
314 conversation
= CdmStore
.createConversation();
320 public void update(CdmDataChangeMap changeEvents
) {
321 // implement where needed