4 package eu
.etaxonomy
.taxeditor
.ui
.selection
;
6 import java
.util
.EnumSet
;
7 import java
.util
.Observable
;
8 import java
.util
.Observer
;
10 import org
.eclipse
.core
.runtime
.IStatus
;
11 import org
.eclipse
.jface
.wizard
.WizardDialog
;
12 import org
.eclipse
.swt
.SWT
;
13 import org
.eclipse
.swt
.events
.SelectionAdapter
;
14 import org
.eclipse
.swt
.events
.SelectionEvent
;
15 import org
.eclipse
.swt
.events
.SelectionListener
;
16 import org
.eclipse
.swt
.graphics
.Color
;
17 import org
.eclipse
.swt
.widgets
.Button
;
18 import org
.eclipse
.swt
.widgets
.Composite
;
19 import org
.eclipse
.swt
.widgets
.Label
;
20 import org
.eclipse
.swt
.widgets
.Shell
;
21 import org
.eclipse
.swt
.widgets
.Text
;
22 import org
.springframework
.security
.core
.GrantedAuthority
;
24 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
25 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
26 import eu
.etaxonomy
.cdm
.common
.CdmUtils
;
27 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
28 import eu
.etaxonomy
.cdm
.model
.common
.Group
;
29 import eu
.etaxonomy
.cdm
.model
.common
.ICdmBase
;
30 import eu
.etaxonomy
.cdm
.model
.common
.IIdentifiableEntity
;
31 import eu
.etaxonomy
.cdm
.model
.common
.User
;
32 import eu
.etaxonomy
.cdm
.model
.molecular
.Amplification
;
33 import eu
.etaxonomy
.cdm
.model
.molecular
.Primer
;
34 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
35 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.CRUD
;
36 import eu
.etaxonomy
.taxeditor
.model
.ImageResources
;
37 import eu
.etaxonomy
.taxeditor
.preference
.Resources
;
38 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
39 import eu
.etaxonomy
.taxeditor
.store
.LoginManager
;
40 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
41 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.selection
.SelectionDialogFactory
;
42 import eu
.etaxonomy
.taxeditor
.ui
.element
.AbstractCdmFormElement
;
43 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmFormFactory
;
44 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmPropertyChangeEvent
;
45 import eu
.etaxonomy
.taxeditor
.ui
.element
.ICdmFormElement
;
46 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEnableableFormElement
;
47 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEntityElement
;
48 import eu
.etaxonomy
.taxeditor
.ui
.element
.ILabeledElement
;
49 import eu
.etaxonomy
.taxeditor
.ui
.element
.ISelectableElement
;
50 import eu
.etaxonomy
.taxeditor
.ui
.element
.LayoutConstants
;
51 import eu
.etaxonomy
.taxeditor
.ui
.element
.SelectionArbitrator
;
52 import eu
.etaxonomy
.taxeditor
.ui
.section
.grantedAuthority
.GrantedAuthorityLabelTextProvider
;
56 * Abstract AbstractSelectionElement class.
60 * @created Nov 17, 2009
64 public class EntitySelectionElement
<T
extends ICdmBase
> extends
65 AbstractCdmFormElement
implements SelectionListener
, IEnableableFormElement
, ISelectableElement
, IEntityElement
<T
>, ILabeledElement
, IConversationEnabled
, Observer
{
67 private static final EnumSet
<CRUD
> UPDATE
= EnumSet
.of(CRUD
.UPDATE
);
68 private static final EnumSet
<CRUD
> DELETE
= EnumSet
.of(CRUD
.DELETE
);
69 private static final EnumSet
<CRUD
> CREATE
= EnumSet
.of(CRUD
.CREATE
);
72 * Bitmask for configuring functionality of selection element
74 public static final int NOTHING
= 0; // 000
75 public static final int EDITABLE
= 1 << 0; // 001
76 public static final int DELETABLE
= 1 << 1; // 010
77 public static final int SELECTABLE
= 1 << 2; // 100
78 public static final int ALL
= EDITABLE
| DELETABLE
| SELECTABLE
; // 111
82 protected Label label
;
84 protected Button button_selection
;
86 private SelectionArbitrator selectionArbitrator
;
88 protected Button button_edit
;
90 private final String labelString
;
92 private Composite selectableComposite
;
94 private Button button_remove
;
96 private final boolean isEditable
;
98 private final boolean isDeletable
;
100 private final ConversationHolder conversation
;
101 private Class
<T
> clazz
;
105 * Constructor for AbstractSelectionElement.
109 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
111 * @param conversation
113 * @param parentElement
114 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
117 * a {@link java.lang.String} object.
122 * @param isSelectable
131 public EntitySelectionElement(CdmFormFactory formFactory
,
132 ConversationHolder conversation
, ICdmFormElement parentElement
,
133 String labelString
, T entity
, int mode
, int style
) {
134 super(formFactory
, parentElement
);
136 this.isEditable
= (mode
& EDITABLE
) == EDITABLE
;
137 this.isDeletable
= (mode
& DELETABLE
) == DELETABLE
;
138 boolean isSelectable
= (mode
& SELECTABLE
) == SELECTABLE
;
140 this.labelString
= (labelString
== null || labelString
.equals("")) ?
"" : labelString
+ " : ";
142 this.conversation
= conversation
;
144 if (isSelectable
&& formFactory
.getSelectionProvider() != null) {
145 selectionArbitrator
= formFactory
.createSelectionArbitrator(this);
148 createControls(getLayoutComposite(), SWT
.NULL
);
153 public EntitySelectionElement(CdmFormFactory formFactory
,
154 ConversationHolder conversation
, ICdmFormElement parentElement
, Class
<T
> clazz
,
155 String labelString
, T entity
, int mode
, int style
) {
156 this(formFactory
, conversation
, parentElement
, labelString
, entity
, mode
, style
);
160 private void createControls(Composite parent
, int style
) {
162 label
= formFactory
.createLabel(getLayoutComposite(), labelString
,
167 selectableComposite
= formFactory
.createComposite(getLayoutComposite());
177 selectableComposite
.setLayout(LayoutConstants
.LAYOUT(columns
, false));
178 selectableComposite
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
180 addControl(selectableComposite
);
182 text
= formFactory
.createText(selectableComposite
, null, SWT
.WRAP
);
183 text
.setEditable(false);
186 text
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
187 text
.setBackground(StoreUtil
188 .getColor(Resources
.COLOR_TEXT_DISABLED_BACKGROUND
));
190 button_selection
= formFactory
.createButton(selectableComposite
, null,
192 button_selection
.setImage(ImageResources
193 .getImage(ImageResources
.BROWSE_ICON
));
194 button_selection
.setToolTipText("Browse existing");
196 addControl(button_selection
);
197 button_selection
.addSelectionListener(this);
200 button_edit
= formFactory
.createButton(selectableComposite
, null,
202 button_edit
.setImage(ImageResources
203 .getImage(ImageResources
.EDIT_ICON
));
204 button_edit
.setToolTipText("Edit");
205 addControl(button_edit
);
206 button_edit
.addSelectionListener(new EditListener(this));
210 button_remove
= formFactory
.createButton(selectableComposite
, null,
212 button_remove
.setImage(ImageResources
213 .getImage(ImageResources
.TRASH_ICON
));
214 button_remove
.setToolTipText("Remove");
215 addControl(button_remove
);
216 button_remove
.addSelectionListener(new DeleteListener(this));
221 public void widgetSelected(SelectionEvent e
) {
222 T selection
= SelectionDialogFactory
.getSelectionFromDialog(clazz
, getShell(), getConversationHolder(), getEntity(), getParentElement());
223 setSelectionInternal(selection
);
227 * Return the selected object
229 * @return a T object.
231 public T
getSelection() {
239 * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
243 public void setEnabled(boolean enabled
) {
245 button_selection
.setEnabled(enabled
);
247 button_remove
.setEnabled(enabled
);
250 updateButtonStates();
256 * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#isEnabled()
259 public boolean isEnabled() {
260 return button_selection
.isEnabled();
265 * setSelectionInternal
271 protected void setSelectionInternal(T selection
) {
272 if (selection
!= null && !selection
.equals(this.entity
)) {
273 setEntity(selection
);
274 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
280 * Setter for the field <code>entity</code>.
286 public void setEntity(T selection
) {
287 this.entity
= selection
;
292 * Updates this elements view
294 protected void updateElement() {
295 String title
= CdmUtils
.Nz(getTitle());
296 text
.setText(title
); // title can be null
298 updateButtonStates();
302 public void updateFromWizard() {
304 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
312 * @return a {@link java.lang.String} object.
314 protected String
getTitle() {
316 if(entity
instanceof IIdentifiableEntity
) {
317 return ((IIdentifiableEntity
) entity
).getTitleCache();
318 } else if(entity
instanceof Group
){
319 return ((Group
) entity
).getName();
320 } else if(entity
instanceof GrantedAuthority
){
321 return GrantedAuthorityLabelTextProvider
.getText(((GrantedAuthority
) entity
));
322 } else if(entity
instanceof User
){
323 return ((User
) entity
).getUsername();
324 } else if (entity
instanceof Primer
){
325 return ((Primer
) entity
).getLabel();
326 } else if (entity
instanceof Amplification
){
327 return ((Amplification
) entity
).getLabelCache();
336 public void setSelected(boolean selected
) {
337 setBackground(selected ? SELECTED
: getPersistentBackground());
343 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
347 * Getter for the field <code>entity</code>.
350 * @return a T object.
353 public T
getEntity() {
360 * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.ISelectableElement#
361 * getSelectionArbitrator()
365 * Getter for the field <code>selectionArbitrator</code>.
368 * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator}
372 public SelectionArbitrator
getSelectionArbitrator() {
373 return selectionArbitrator
;
377 * Convenient access to current shell
379 * @return a {@link org.eclipse.swt.widgets.Shell} object.
381 public Shell
getShell() {
382 return getLayoutComposite().getShell();
387 public void setIrrelevant(boolean irrelevant
) {
388 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
389 : Resources
.COLOR_TEXT_DISABLED_BACKGROUND
;
391 Color color
= StoreUtil
.getColor(colorId
);
392 text
.setBackground(color
);
395 private class DeleteListener
extends SelectionAdapter
{
397 private final EntitySelectionElement
<T
> selectionElement
;
399 public DeleteListener(EntitySelectionElement
<T
> selectionElement
) {
400 this.selectionElement
= selectionElement
;
404 public void widgetSelected(SelectionEvent e
) {
406 firePropertyChangeEvent(new CdmPropertyChangeEvent(
407 selectionElement
, null));
411 private class EditListener
extends SelectionAdapter
{
413 private final EntitySelectionElement
<T
> selectionElement
;
415 public EditListener(EntitySelectionElement
<T
> selectionElement
) {
416 this.selectionElement
= selectionElement
;
421 public void widgetSelected(SelectionEvent e
) {
422 WizardDialog dialog
= new WizardDialog(selectionElement
.getShell(),
423 new EditFromSelectionWizard(selectionElement
));
424 if (dialog
.open() == IStatus
.OK
) {
425 selectionElement
.updateFromWizard();
433 public void widgetDefaultSelected(SelectionEvent e
) {
438 * getConversationHolder
441 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
445 public ConversationHolder
getConversationHolder() {
451 public void setBackground(Color color
) {
452 if(!label
.isDisposed()){
453 label
.setBackground(color
);
459 public void setLabel(String labelString
) {
461 label
.setText(labelString
);
467 * Getter for the field <code>label</code>.
470 * @return a {@link java.lang.String} object.
473 public String
getLabel() {
475 return label
.getText() + " : ";
482 public void update(CdmDataChangeMap changeEvents
) {
486 * @see eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement#removeElements()
489 public void removeElements(){
490 super.removeElements();
491 LoginManager loginManager
= CdmStore
.getLoginManager();
492 loginManager
.addObserver(this);
496 public void update(Observable o
, Object arg
) {
497 if(o
instanceof LoginManager
){
498 updateButtonStates();
502 private void updateButtonStates() {
503 if(button_edit
!= null && !button_selection
.isDisposed()){
504 button_edit
.setEnabled(isEditable
&& button_selection
.isEnabled() && getEntity() != null && CdmStore
.currentAuthentiationHasPermission((CdmBase
) getEntity(), UPDATE
));