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
.Primer
;
33 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
34 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.CRUD
;
35 import eu
.etaxonomy
.taxeditor
.model
.ImageResources
;
36 import eu
.etaxonomy
.taxeditor
.preference
.Resources
;
37 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
38 import eu
.etaxonomy
.taxeditor
.store
.LoginManager
;
39 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
40 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.selection
.SelectionDialogFactory
;
41 import eu
.etaxonomy
.taxeditor
.ui
.element
.AbstractCdmFormElement
;
42 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmFormFactory
;
43 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmPropertyChangeEvent
;
44 import eu
.etaxonomy
.taxeditor
.ui
.element
.ICdmFormElement
;
45 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEnableableFormElement
;
46 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEntityElement
;
47 import eu
.etaxonomy
.taxeditor
.ui
.element
.ILabeledElement
;
48 import eu
.etaxonomy
.taxeditor
.ui
.element
.ISelectableElement
;
49 import eu
.etaxonomy
.taxeditor
.ui
.element
.LayoutConstants
;
50 import eu
.etaxonomy
.taxeditor
.ui
.element
.SelectionArbitrator
;
51 import eu
.etaxonomy
.taxeditor
.ui
.section
.grantedAuthority
.GrantedAuthorityLabelTextProvider
;
55 * Abstract AbstractSelectionElement class.
59 * @created Nov 17, 2009
63 public class EntitySelectionElement
<T
extends ICdmBase
> extends
64 AbstractCdmFormElement
implements SelectionListener
, IEnableableFormElement
, ISelectableElement
, IEntityElement
<T
>, ILabeledElement
, IConversationEnabled
, Observer
{
66 private static final EnumSet
<CRUD
> UPDATE
= EnumSet
.of(CRUD
.UPDATE
);
67 private static final EnumSet
<CRUD
> DELETE
= EnumSet
.of(CRUD
.DELETE
);
68 private static final EnumSet
<CRUD
> CREATE
= EnumSet
.of(CRUD
.CREATE
);
71 * Bitmask for configuring functionality of selection element
73 public static final int NOTHING
= 0; // 000
74 public static final int EDITABLE
= 1 << 0; // 001
75 public static final int DELETABLE
= 1 << 1; // 010
76 public static final int SELECTABLE
= 1 << 2; // 100
77 public static final int ALL
= EDITABLE
| DELETABLE
| SELECTABLE
; // 111
81 protected Label label
;
83 protected Button button_selection
;
85 private SelectionArbitrator selectionArbitrator
;
87 protected Button button_edit
;
89 private final String labelString
;
91 private Composite selectableComposite
;
93 private Button button_remove
;
95 private final boolean isEditable
;
97 private final boolean isDeletable
;
99 private final ConversationHolder conversation
;
100 private Class
<T
> clazz
;
104 * Constructor for AbstractSelectionElement.
108 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
110 * @param conversation
112 * @param parentElement
113 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
116 * a {@link java.lang.String} object.
121 * @param isSelectable
130 public EntitySelectionElement(CdmFormFactory formFactory
,
131 ConversationHolder conversation
, ICdmFormElement parentElement
,
132 String labelString
, T entity
, int mode
, int style
) {
133 super(formFactory
, parentElement
);
135 this.isEditable
= (mode
& EDITABLE
) == EDITABLE
;
136 this.isDeletable
= (mode
& DELETABLE
) == DELETABLE
;
137 boolean isSelectable
= (mode
& SELECTABLE
) == SELECTABLE
;
139 this.labelString
= labelString
;
141 this.conversation
= conversation
;
143 if (isSelectable
&& formFactory
.getSelectionProvider() != null) {
144 selectionArbitrator
= formFactory
.createSelectionArbitrator(this);
147 createControls(getLayoutComposite(), SWT
.NULL
);
152 public EntitySelectionElement(CdmFormFactory formFactory
,
153 ConversationHolder conversation
, ICdmFormElement parentElement
, Class
<T
> clazz
,
154 String labelString
, T entity
, int mode
, int style
) {
155 this(formFactory
, conversation
, parentElement
, labelString
, entity
, mode
, style
);
159 private void createControls(Composite parent
, int style
) {
161 label
= formFactory
.createLabel(getLayoutComposite(), labelString
+ " : ",
166 selectableComposite
= formFactory
.createComposite(getLayoutComposite());
176 selectableComposite
.setLayout(LayoutConstants
.LAYOUT(columns
, false));
177 selectableComposite
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
179 addControl(selectableComposite
);
181 text
= formFactory
.createText(selectableComposite
, null, SWT
.WRAP
);
182 text
.setEditable(false);
185 text
.setLayoutData(LayoutConstants
.FILL_HORIZONTALLY());
186 text
.setBackground(StoreUtil
187 .getColor(Resources
.COLOR_TEXT_DISABLED_BACKGROUND
));
189 button_selection
= formFactory
.createButton(selectableComposite
, null,
191 button_selection
.setImage(ImageResources
192 .getImage(ImageResources
.BROWSE_ICON
));
193 button_selection
.setToolTipText("Browse existing");
195 addControl(button_selection
);
196 button_selection
.addSelectionListener(this);
199 button_edit
= formFactory
.createButton(selectableComposite
, null,
201 button_edit
.setImage(ImageResources
202 .getImage(ImageResources
.EDIT_ICON
));
203 button_edit
.setToolTipText("Edit");
204 addControl(button_edit
);
205 button_edit
.addSelectionListener(new EditListener(this));
209 button_remove
= formFactory
.createButton(selectableComposite
, null,
211 button_remove
.setImage(ImageResources
212 .getImage(ImageResources
.TRASH_ICON
));
213 button_remove
.setToolTipText("Remove");
214 addControl(button_remove
);
215 button_remove
.addSelectionListener(new DeleteListener(this));
220 public void widgetSelected(SelectionEvent e
) {
221 T selection
= SelectionDialogFactory
.getSelectionFromDialog(clazz
, getShell(), getConversationHolder(), getEntity());
222 setSelectionInternal(selection
);
226 * Return the selected object
228 * @return a T object.
230 public T
getSelection() {
238 * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
242 public void setEnabled(boolean enabled
) {
243 button_selection
.setEnabled(enabled
);
245 updateButtonStates();
251 * setSelectionInternal
257 protected void setSelectionInternal(T selection
) {
258 if (selection
!= null && !selection
.equals(this.entity
)) {
259 setEntity(selection
);
260 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
266 * Setter for the field <code>entity</code>.
272 public void setEntity(T selection
) {
273 this.entity
= selection
;
278 * Updates this elements view
280 protected void updateElement() {
281 String title
= CdmUtils
.Nz(getTitle());
282 // we have to duplicate ampersands otherwise they are treated as
283 // mnenomic (see Label.setText() documentation)
284 title
= title
.replace("&", "&&");
285 text
.setText(title
); // title can be null
287 updateButtonStates();
291 public void updateFromWizard() {
293 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
301 * @return a {@link java.lang.String} object.
303 protected String
getTitle() {
305 if(entity
instanceof IIdentifiableEntity
) {
306 return ((IIdentifiableEntity
) entity
).getTitleCache();
307 } else if(entity
instanceof Group
){
308 return ((Group
) entity
).getName();
309 } else if(entity
instanceof GrantedAuthority
){
310 return GrantedAuthorityLabelTextProvider
.getText(((GrantedAuthority
) entity
));
311 } else if(entity
instanceof User
){
312 return ((User
) entity
).getUsername();
313 } else if (entity
instanceof Primer
){
314 return ((Primer
) entity
).getLabel();
323 public void setSelected(boolean selected
) {
324 setBackground(selected ? SELECTED
: getPersistentBackground());
330 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
334 * Getter for the field <code>entity</code>.
337 * @return a T object.
340 public T
getEntity() {
347 * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.ISelectableElement#
348 * getSelectionArbitrator()
352 * Getter for the field <code>selectionArbitrator</code>.
355 * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator}
359 public SelectionArbitrator
getSelectionArbitrator() {
360 return selectionArbitrator
;
364 * Convenient access to current shell
366 * @return a {@link org.eclipse.swt.widgets.Shell} object.
368 public Shell
getShell() {
369 return getLayoutComposite().getShell();
374 public void setIrrelevant(boolean irrelevant
) {
375 String colorId
= irrelevant ? Resources
.COLOR_COMPOSITE_IRRELEVANT
376 : Resources
.COLOR_TEXT_DISABLED_BACKGROUND
;
378 Color color
= StoreUtil
.getColor(colorId
);
379 text
.setBackground(color
);
382 private class DeleteListener
extends SelectionAdapter
{
384 private final EntitySelectionElement
<T
> selectionElement
;
386 public DeleteListener(EntitySelectionElement
<T
> selectionElement
) {
387 this.selectionElement
= selectionElement
;
391 public void widgetSelected(SelectionEvent e
) {
393 firePropertyChangeEvent(new CdmPropertyChangeEvent(
394 selectionElement
, null));
398 private class EditListener
extends SelectionAdapter
{
400 private final EntitySelectionElement
<T
> selectionElement
;
402 public EditListener(EntitySelectionElement
<T
> selectionElement
) {
403 this.selectionElement
= selectionElement
;
408 public void widgetSelected(SelectionEvent e
) {
409 WizardDialog dialog
= new WizardDialog(selectionElement
.getShell(),
410 new EditFromSelectionWizard(selectionElement
));
411 if (dialog
.open() == IStatus
.OK
) {
412 selectionElement
.updateFromWizard();
420 public void widgetDefaultSelected(SelectionEvent e
) {
425 * getConversationHolder
428 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
432 public ConversationHolder
getConversationHolder() {
438 public void setBackground(Color color
) {
439 label
.setBackground(color
);
444 public void setLabel(String labelString
) {
446 label
.setText(labelString
);
452 * Getter for the field <code>label</code>.
455 * @return a {@link java.lang.String} object.
458 public String
getLabel() {
460 return label
.getText() + " : ";
467 public void update(CdmDataChangeMap changeEvents
) {
471 * @see eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement#removeElements()
474 public void removeElements(){
475 super.removeElements();
476 LoginManager loginManager
= CdmStore
.getLoginManager();
477 loginManager
.addObserver(this);
481 public void update(Observable o
, Object arg
) {
482 if(o
instanceof LoginManager
){
483 updateButtonStates();
487 private void updateButtonStates() {
488 if(button_edit
!= null && !button_selection
.isDisposed()){
489 button_edit
.setEnabled(isEditable
&& button_selection
.isEnabled() && getEntity() != null && CdmStore
.currentAuthentiationHasPermission((CdmBase
) getEntity(), UPDATE
));