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
;
54 * <p>Abstract AbstractMenuPreferences class.</p>
60 public abstract class AbstractMenuPreferences
<T
extends DefinedTermBase
> extends CdmPreferencePage
implements
61 IWorkbenchPreferencePage
, IConversationEnabled
{
63 private Button toggleButton
;
64 protected HashMap
<DefinedTermBase
<T
>, Button
> menuButtons
;
66 protected Button newButton
;
67 protected Button editButton
;
68 protected Button removeButton
;
70 protected CheckboxTableViewer tableViewer
;
72 private boolean state
= true;
73 private final boolean vocabularyIsEditable
;
74 private ConversationHolder conversation
;
77 * Constructs a new menu preference page.
79 * @param initialVocabulary
80 * the initial vocabulary containing all possible entries for the menu
82 * the title of the page
84 * describing text for the preference page
86 * whether this vocabulary should be editable. Will render "New", "Edit", "Delete" buttons
87 * Handler for these buttons have to be overriding addEditButtonListeners()
88 * @param <T> a T object.
90 public AbstractMenuPreferences(String title
, String description
, boolean editable
) {
92 vocabularyIsEditable
= editable
;
93 setDescription(description
);
96 protected List
<T
> getTerms(){
97 if(!CdmStore
.isActive()) {
98 return new ArrayList
<T
>();
100 return TermStore
.getTerms(getTermClass());
107 * Create contents of the preference page
110 public Control
createContents(Composite parent
) {
112 Composite container
= new Composite(parent
, SWT
.NULL
);
113 final GridLayout gridLayout
= new GridLayout();
114 gridLayout
.numColumns
= 2;
115 container
.setLayout(gridLayout
);
117 tableViewer
= CheckboxTableViewer
.newCheckList(container
, SWT
.NULL
);
118 GridData tableLayoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, false);
119 tableLayoutData
.heightHint
= 300;
120 tableViewer
.getTable().setLayoutData(tableLayoutData
);
122 tableViewer
.setContentProvider(new DefinedTermBaseContentProvider());
123 tableViewer
.setLabelProvider(new DefinedTermBaseLabelProvider());
127 tableViewer
.addCheckStateListener(new ICheckStateListener() {
130 public void checkStateChanged(CheckStateChangedEvent arg0
) {
135 Composite buttonContainer
= new Composite(container
, SWT
.NULL
);
136 GridData buttonContainerLayoutData
= new GridData();
137 buttonContainerLayoutData
.verticalAlignment
= SWT
.TOP
;
138 buttonContainer
.setLayoutData(buttonContainerLayoutData
);
139 buttonContainer
.setLayout(new GridLayout());
141 if(vocabularyIsEditable
) {
142 createEditButtons(buttonContainer
);
145 toggleButton
= new Button(buttonContainer
, SWT
.PUSH
);
146 toggleButton
.setText("Toggle");
147 toggleButton
.addSelectionListener(new SelectionAdapter(){
149 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
152 public void widgetSelected(SelectionEvent e
) {
153 state
= state ?
false : true;
154 tableViewer
.setAllChecked(state
);
159 createAdditionalContent(container
);
168 * @param definedTerms a {@link java.util.List} object.
170 protected void refresh(List
<T
> definedTerms
) {
171 tableViewer
.setInput(definedTerms
);
173 List
<T
> preferedTerms
= CdmStore
.getTermManager().getFilteredTerms(definedTerms
);
174 tableViewer
.setCheckedElements(preferedTerms
.toArray());
178 * <p>createAdditionalContent</p>
180 * @param container a {@link org.eclipse.swt.widgets.Composite} object.
182 protected void createAdditionalContent(Composite container
) {
183 // implement where needed
187 * @see eu.etaxonomy.taxeditor.preference.AbstractMenuPreferences#createButtons(org.eclipse.swt.widgets.Composite)
190 * <p>createEditButtons</p>
192 * @param buttonContainer a {@link org.eclipse.swt.widgets.Composite} object.
194 protected void createEditButtons(Composite buttonContainer
) {
196 editButton
= new Button(buttonContainer
, SWT
.PUSH
);
197 editButton
.setText("Open Term Editor");
198 editButton
.setLayoutData(new GridData(SWT
.FILL
));
200 addEditButtonListeners();
204 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
207 protected void addNewButtonListeners() {
208 newButton
.addSelectionListener(new SelectionAdapter(){
210 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
213 public void widgetSelected(SelectionEvent e
) {
214 VocabularyTermWizard
<T
> wizard
= new VocabularyTermWizard
<T
>(getTermClass(), getConversationHolder());
216 WizardDialog dialog
= new WizardDialog(AbstractUtility
.getShell(), wizard
);
217 if(dialog
.open() == IStatus
.OK
){
218 tableViewer
.setInput(getTerms());
227 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag
230 protected void addEditButtonListeners() {
231 editButton
.addSelectionListener(new SelectionAdapter(){
233 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
236 public void widgetSelected(SelectionEvent event
) {
238 ICommandService commandService
= (ICommandService
) AbstractUtility
.getService(ICommandService
.class);
240 Command command
= commandService
.getCommand(DefinedTermEditor
.OPEN_COMMAND_ID
);
242 IParameter parameter
;
244 parameter
= command
.getParameter("eu.etaxonomy.taxeditor.store.openDefinedTermEditor.termTypeUuid");
246 Parameterization
[] parameterizations
= new Parameterization
[]{
247 new Parameterization(parameter
, TermType
.valueOf(getTermClass().getSimpleName()).getUuid().toString())
250 ParameterizedCommand pCommand
= new ParameterizedCommand(command
, parameterizations
);
252 if (command
.isEnabled()) {
253 IHandlerService handlerService
= (IHandlerService
) AbstractUtility
.getService(IHandlerService
.class);
255 handlerService
.executeCommand(pCommand
, null);
256 } catch (NotDefinedException e
) {
257 throw new RuntimeException("Could not find open command: "
258 + DefinedTermEditor
.OPEN_COMMAND_ID
);
259 } catch (Exception e
) {
262 "An exception occured while trying to open a selection",
266 } catch (NotDefinedException e
) {
269 "An exception occured while trying to open the Term Editor",
279 public void init(IWorkbench workbench
) {
280 setPreferenceStore(PreferencesUtil
.getPreferenceStore());
281 if(!CdmStore
.isActive()) {
282 MessagingUtils
.noDataSourceWarningDialog(null);
285 getConversationHolder().bind();
291 * @see org.eclipse.jface.preference.PreferencePage#performDefaults()
294 * <p>performDefaults</p>
297 protected void performDefaults() {
298 tableViewer
.setAllChecked(true);
302 * <p>Getter for the field <code>tableViewer</code>.</p>
304 * @return the tableViewer
306 public CheckboxTableViewer
getTableViewer() {
311 * @see org.eclipse.jface.preference.PreferencePage#performOk()
315 public boolean performOk() {
316 if(!CdmStore
.isActive()) {
320 if(checkNoneChecked()){
324 getConversationHolder().commit(true);
326 List
<T
> preferredTerms
= new ArrayList
<T
>();
327 for (Object element
: getTableViewer().getCheckedElements()){
328 preferredTerms
.add((T
) element
);
331 CdmStore
.getTermManager().setPreferredTerms(preferredTerms
, getTerms());
333 PreferencesUtil
.firePreferencesChanged(this.getClass());
336 return super.performOk();
339 private boolean checkNoneChecked(){
341 if(tableViewer
.getCheckedElements().length
== 0){
342 setMessage("Please check at least one item", WARNING
);
351 * <p>getTermClass</p>
353 * @return a {@link java.lang.Class} object.
355 protected abstract Class
<T
> getTermClass();
358 * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
361 public ConversationHolder
getConversationHolder() {
362 if(conversation
== null){
363 conversation
= CdmStore
.createConversation();
369 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
372 public void update(CdmDataChangeMap changeEvents
) {
373 // implement where needed