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
.ui
.dialogs
.filteredSelection
;
13 import java
.lang
.reflect
.Field
;
14 import java
.security
.acl
.LastOwnerException
;
15 import java
.text
.Collator
;
16 import java
.util
.Comparator
;
17 import java
.util
.HashSet
;
18 import java
.util
.List
;
20 import java
.util
.UUID
;
22 import org
.eclipse
.core
.runtime
.CoreException
;
23 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
24 import org
.eclipse
.core
.runtime
.IStatus
;
25 import org
.eclipse
.core
.runtime
.OperationCanceledException
;
26 import org
.eclipse
.core
.runtime
.Status
;
27 import org
.eclipse
.jface
.dialogs
.IDialogSettings
;
28 import org
.eclipse
.jface
.viewers
.ILabelProvider
;
29 import org
.eclipse
.jface
.viewers
.LabelProvider
;
30 import org
.eclipse
.jface
.window
.Window
;
31 import org
.eclipse
.jface
.wizard
.WizardDialog
;
32 import org
.eclipse
.swt
.SWT
;
33 import org
.eclipse
.swt
.events
.ModifyEvent
;
34 import org
.eclipse
.swt
.events
.SelectionAdapter
;
35 import org
.eclipse
.swt
.events
.SelectionEvent
;
36 import org
.eclipse
.swt
.events
.SelectionListener
;
37 import org
.eclipse
.swt
.widgets
.Composite
;
38 import org
.eclipse
.swt
.widgets
.Control
;
39 import org
.eclipse
.swt
.widgets
.Link
;
40 import org
.eclipse
.swt
.widgets
.Shell
;
41 import org
.eclipse
.swt
.widgets
.Text
;
42 import org
.eclipse
.ui
.IMemento
;
43 import org
.eclipse
.ui
.dialogs
.FilteredItemsSelectionDialog
;
45 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
46 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
47 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
48 import eu
.etaxonomy
.cdm
.model
.common
.ICdmBase
;
49 import eu
.etaxonomy
.cdm
.model
.common
.IIdentifiableEntity
;
50 import eu
.etaxonomy
.cdm
.model
.common
.UuidAndTitleCache
;
51 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
52 import eu
.etaxonomy
.taxeditor
.newWizard
.AbstractNewEntityWizard
;
53 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
54 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
57 * <p>Abstract AbstractFilteredCdmResourceSelectionDialog class.</p>
63 public abstract class AbstractFilteredCdmResourceSelectionDialog
<T
extends ICdmBase
> extends
64 FilteredItemsSelectionDialog
implements IConversationEnabled
{
66 private ConversationHolder conversation
;
68 protected List
<UuidAndTitleCache
<T
>> model
;
69 private Set
<T
> transientCdmObjects
= new HashSet
<T
>();
70 private String settings
;
73 * <p>Constructor for AbstractFilteredCdmResourceSelectionDialog.</p>
75 * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
77 * @param title a {@link java.lang.String} object.
78 * @param multi a boolean.
79 * @param settings a {@link java.lang.String} object.
80 * @param cdmObject a T object.
81 * @param <T> a T object.
83 protected AbstractFilteredCdmResourceSelectionDialog(Shell shell
, ConversationHolder conversation
, String title
, boolean multi
, String settings
, T cdmObject
) {
86 setMessage("Use * for wildcard, or ? to see all entries");
87 this.settings
= settings
;
89 this.conversation
= conversation
;
95 if (cdmObject
!= null) {
96 setInitialPattern(getTitle(cdmObject
));
99 ILabelProvider labelProvider
= new FilteredCdmResourceLabelProvider();
100 setListLabelProvider(labelProvider
);
101 setDetailsLabelProvider(labelProvider
);
103 setSelectionHistory(new ResourceSelectionHistory());
107 * Override in subclasses.
108 * Will run before initModel()
110 protected void init() {
115 * <p>getSelectionFromDialog</p>
117 * @param dialog a {@link eu.etaxonomy.taxeditor.ui.dialogs.filteredSelection.AbstractFilteredCdmResourceSelectionDialog} object.
118 * @param <TYPE> a TYPE object.
119 * @return a TYPE object.
121 protected static <TYPE
extends CdmBase
> TYPE
getSelectionFromDialog(AbstractFilteredCdmResourceSelectionDialog
<TYPE
> dialog
) {
122 //dialog.setInitialPattern("");
123 int result
= dialog
.open();
125 if (result
== Window
.CANCEL
) {
129 UUID uuid
= dialog
.getSelectedUuidAndTitleCache().getUuid();
133 return dialog
.getCdmObjectByUuid(uuid
);
137 * Check if object was created during the life of this dialog. If not,
138 * retrieve it from the CdmStore.
140 * @param cdmUuid a {@link java.util.UUID} object.
141 * @return a T object.
143 protected T
getCdmObjectByUuid(UUID cdmUuid
) {
144 for (T cdmObject
: transientCdmObjects
) {
145 if (cdmObject
.getUuid().equals(cdmUuid
)) {
149 return getPersistentObject(cdmUuid
);
153 * <p>getPersistentObject</p>
155 * @param uuid a {@link java.util.UUID} object.
156 * @return a T object.
158 abstract protected T
getPersistentObject(UUID uuid
);
163 // protected void addObjectToModel(T cdmObject) {
164 // model.add(new UuidAndTitleCache(cdmObject.getClass(), cdmObject.getUuid(), getTitle(cdmObject)));
165 // transientCdmObjects.add(cdmObject);
169 * <p>isObjectTransient</p>
171 * @param cdmObject a T object.
174 protected boolean isObjectTransient(T cdmObject
) {
175 return (getPersistentObject(cdmObject
.getUuid()) == null);
181 * @param cdmObject a T object.
182 * @return a {@link java.lang.String} object.
184 protected String
getTitle(T cdmObject
) {
185 if (cdmObject
instanceof IIdentifiableEntity
) {
186 return ((IIdentifiableEntity
) cdmObject
).getTitleCache();
194 public void refresh() {
202 abstract protected void initModel();
205 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createFilter()
209 protected ItemsFilter
createFilter() {
210 return new ItemsFilter() {
213 * Always returns false to enforce refiltering even if the pattern is equal
216 public boolean equalsFilter(ItemsFilter filter
) {
221 public boolean isConsistentItem(Object item
) {
226 public boolean matchItem(Object item
) {
228 if(item
instanceof UuidAndTitleCache
){
229 text
= ((UuidAndTitleCache
) item
).getTitleCache();
230 }else if(item
instanceof String
){
231 text
= (String
) item
;
233 return text
!= null ?
matches(text
) : false;
241 * Set the filter input to the Agent's title cache
243 * @param cdmObject a T object.
245 protected void setPattern(T cdmObject
) {
246 // FilteredSelection does some very tricky caching to make sure it
247 // runs with high performance.
248 // This works for most use cases, but we want to change the model while the dialog is open
249 // and all the clever caching prevents the content provider from knowing that the model has changed
250 // I am aware, that this is a hack, but the FilteredSelectionDialog API does not offer a convenient
251 // way to solve the problem.
253 Field lastCompletedFilter
= this.getClass().getSuperclass().getSuperclass().getDeclaredField("lastCompletedFilter");
254 lastCompletedFilter
.setAccessible(true);
255 lastCompletedFilter
.set(this, null);
256 } catch (SecurityException e
) {
257 StoreUtil
.error(getClass(), e
);
258 } catch (NoSuchFieldException e
) {
259 StoreUtil
.error(getClass(), e
);
260 } catch (IllegalArgumentException e
) {
261 StoreUtil
.error(getClass(), e
);
262 } catch (IllegalAccessException e
) {
263 StoreUtil
.error(getClass(), e
);
266 // this also is not the nicest way to do it.
267 // I am still amazed, that FilteredSelectionDialog does not offer any methods to change its data
268 // once it was opened. Am I doing it wrong?
269 ((Text
) getPatternControl()).setText(getTitle(cdmObject
));
273 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter, org.eclipse.core.runtime.IProgressMonitor)
277 protected void fillContentProvider(AbstractContentProvider contentProvider
,
278 ItemsFilter itemsFilter
, IProgressMonitor progressMonitor
)
279 throws CoreException
{
282 progressMonitor
.beginTask("Looking for entities", model
.size());
283 for(UuidAndTitleCache
<T
> element
: model
){
284 contentProvider
.add(element
, itemsFilter
);
285 if (progressMonitor
.isCanceled()) {
286 throw new OperationCanceledException();
288 progressMonitor
.worked(1);
291 StoreUtil
.warn(getClass(), "Model for Filtered Selection is null:" + this.getClass().getSimpleName());
295 progressMonitor
.done();
300 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getDialogSettings()
304 protected IDialogSettings
getDialogSettings() {
305 IDialogSettings settings
= TaxeditorStorePlugin
.getDefault().getDialogSettings().getSection(getSettings());
307 if (settings
== null) {
308 settings
= TaxeditorStorePlugin
.getDefault().getDialogSettings().addNewSection(getSettings());
314 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getElementName(java.lang.Object)
318 public String
getElementName(Object item
) {
319 return ((UuidAndTitleCache
) item
).getTitleCache();
323 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getItemsComparator()
327 protected Comparator
getItemsComparator() {
328 return new Comparator
<UuidAndTitleCache
>() {
329 public int compare(UuidAndTitleCache entity1
,
330 UuidAndTitleCache entity2
) {
331 Collator collator
= Collator
.getInstance();
332 return collator
.compare(entity1
.getTitleCache(), entity2
.getTitleCache());
338 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#validateItem(java.lang.Object)
342 protected IStatus
validateItem(Object item
) {
343 return Status
.OK_STATUS
;
347 * <p>getSelectedUuidAndTitleCache</p>
349 * @return a {@link eu.etaxonomy.cdm.model.common.UuidAndTitleCache} object.
351 protected UuidAndTitleCache
getSelectedUuidAndTitleCache() {
352 Object
[] result
= getResult();
353 return result
[0] == null ?
null : (UuidAndTitleCache
) result
[0];
357 * <p>Getter for the field <code>settings</code>.</p>
359 * @return a {@link java.lang.String} object.
361 public String
getSettings() {
362 if(settings
== null){
363 throw new IllegalStateException("No SETTINGS set.");
371 * @created Oct 19, 2009
374 private class ResourceSelectionHistory
extends SelectionHistory
{
376 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#restoreItemFromMemento(org.eclipse.ui.IMemento)
378 protected Object
restoreItemFromMemento(IMemento element
) {
379 return element
.getString("resource"); //$NON-NLS-1$
382 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#storeItemToMemento(java.lang.Object,
383 * org.eclipse.ui.IMemento)
385 protected void storeItemToMemento(Object item
, IMemento element
) {
386 element
.putString("resource", item
.toString()); //$NON-NLS-1$
391 * <p>getNewWizardLinkText</p>
393 * @return a {@link java.lang.String} object.
395 protected abstract String
getNewWizardLinkText();
398 * <p>getNewEntityWizard</p>
400 * @return a {@link eu.etaxonomy.taxeditor.newWizard.AbstractNewEntityWizard} object.
402 protected abstract AbstractNewEntityWizard
getNewEntityWizard(String parameter
);
404 public class FilteredCdmResourceLabelProvider
extends LabelProvider
{
405 public String
getText(Object element
) {
406 if (element
== null) {
409 return ((UuidAndTitleCache
) element
).getTitleCache();
414 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createExtendedContentArea(org.eclipse.swt.widgets.Composite)
418 protected Control
createExtendedContentArea(Composite parent
) {
419 if(getNewWizardLinkText() != null){
420 Link link
= new Link(parent
, SWT
.NONE
);
421 link
.setText(getNewWizardLinkText());
422 link
.addSelectionListener(getNewWizardLinkSelectionListener());
428 protected SelectionListener
getNewWizardLinkSelectionListener(){
429 return new SelectionAdapter() {
432 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
435 public void widgetSelected(SelectionEvent e
) {
437 AbstractNewEntityWizard wizard
= getNewEntityWizard(e
.text
);
438 wizard
.init(null, null);
439 WizardDialog dialog
= new WizardDialog(getShell(), wizard
);
440 int status
= dialog
.open();
442 if (status
== IStatus
.OK
) {
444 T entity
= (T
) wizard
.getEntity();
446 // addObjectToModel(teamOrPerson);
456 * <p>getConversationHolder</p>
458 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
460 public ConversationHolder
getConversationHolder() {
465 public void update(CdmDataChangeMap changeEvents
) {}