4 package eu
.etaxonomy
.taxeditor
.ui
.element
;
6 import java
.util
.ConcurrentModificationException
;
7 import java
.util
.HashSet
;
11 import org
.eclipse
.core
.runtime
.Assert
;
12 import org
.eclipse
.jface
.util
.IPropertyChangeListener
;
13 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
14 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
15 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
16 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
17 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
18 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
19 import org
.eclipse
.swt
.SWT
;
20 import org
.eclipse
.swt
.events
.SelectionEvent
;
21 import org
.eclipse
.swt
.events
.SelectionListener
;
22 import org
.eclipse
.swt
.graphics
.Color
;
23 import org
.eclipse
.swt
.widgets
.Composite
;
24 import org
.eclipse
.swt
.widgets
.Control
;
25 import org
.eclipse
.swt
.widgets
.Display
;
26 import org
.eclipse
.swt
.widgets
.TypedListener
;
27 import org
.eclipse
.swt
.widgets
.Widget
;
28 import org
.eclipse
.ui
.IEditorPart
;
29 import org
.eclipse
.ui
.forms
.widgets
.Section
;
30 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
31 import org
.eclipse
.ui
.forms
.widgets
.ToggleHyperlink
;
33 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
34 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
35 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
36 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
37 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
41 * Abstract super class for a {@link Section} GUI element that visualizes a CDM
42 * entity, manages a conversation and listens to selections
45 * @param <ENTITY> A CDM entity which should be visualized by this section.
48 * @created Feb 22, 2010
52 //TODO shouldn't ENTITY be bound with super class ICdmBase for example (AbstractFormSection<ENTITY extends ICdmBase>)?
53 public abstract class AbstractFormSection
<ENTITY
> extends Section
implements ISelectionChangedListener
, IEntityElement
<ENTITY
>, IConversationEnabled
{
56 * The default number of columns in detail sections
58 public static final int DEFAULT_NUM_COLUMNS
= 2;
60 private ISelectionProvider selectionProvider
;
62 private ENTITY entity
;
64 private final Set
<ICdmFormElement
> elements
= new HashSet
<ICdmFormElement
>();
66 protected CdmFormFactory formFactory
;
68 private List
<IPropertyChangeListener
> propertyChangeListeners
;
70 private ICdmFormElement parentElement
;
72 private Color persistentBackgroundColor
;
76 * Constructor for AbstractFormSection.
84 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
86 * @param parentElement
87 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
92 protected AbstractFormSection(CdmFormFactory formFactory
, ICdmFormElement parentElement
, int style
) {
93 super(parentElement
.getLayoutComposite(), style
);
95 this.parentElement
= parentElement
;
97 this.formFactory
= formFactory
;
99 this.setLayoutData(LayoutConstants
.FILL());
101 Composite client
= formFactory
.createComposite(this, SWT
.WRAP
);
102 client
.setBackgroundMode(SWT
.INHERIT_DEFAULT
);
104 TableWrapLayout layout
= LayoutConstants
.LAYOUT();
105 layout
.bottomMargin
= 10;
106 layout
.rightMargin
= 5;
107 layout
.horizontalSpacing
= 5;
109 client
.setLayout(layout
);
111 this.setClient(client
);
117 * Constructor for AbstractFormSection.
121 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
123 * @param conversation
124 * a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
126 * @param parentElement
127 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
129 * @param selectionProvider
130 * a {@link org.eclipse.jface.viewers.ISelectionProvider} object.
134 protected AbstractFormSection(CdmFormFactory formFactory
, ICdmFormElement parentElement
, ISelectionProvider selectionProvider
, int style
) {
135 this(formFactory
, parentElement
, style
);
136 this.selectionProvider
= selectionProvider
;
141 * Getter for the field <code>propertyChangeListeners</code>.
144 * @return a {@link java.util.Set} object.
147 public List
<IPropertyChangeListener
> getPropertyChangeListeners() {
148 return propertyChangeListeners
;
153 public void setPropertyChangeListeners(
154 List
<IPropertyChangeListener
> propertyChangeListeners
) {
155 this.propertyChangeListeners
= propertyChangeListeners
;
160 * Setter for the field <code>entity</code>.
166 public void setEntity(ENTITY entity
) {
167 this.entity
= entity
;
173 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
177 * Getter for the field <code>entity</code>.
180 * @return a ENTITY object.
183 public ENTITY
getEntity() {
192 * @return a {@link org.eclipse.ui.forms.widgets.ToggleHyperlink} object.
194 public ToggleHyperlink
getToggle() {
203 * @return a {@link eu.etaxonomy.taxeditor.ui.element.AbstractFormSection}
206 public AbstractFormSection
<ENTITY
> getSection() {
214 * eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent
219 public void firePropertyChangeEvent(CdmPropertyChangeEvent event
) {
220 Assert
.isNotNull(propertyChangeListeners
, "No property change listeners.");
222 for (Object listener
: propertyChangeListeners
) {
223 ((IPropertyChangeListener
) listener
).propertyChange(event
);
225 } catch (ConcurrentModificationException e
) {
226 MessagingUtils
.warn(getClass(), "ConcurrentModificationException while handling PropertyChangeEvents."
227 + " It seems like this is not critical");
232 * Fires a {@link CdmPropertyChangeEvent} with the given object as source.
235 * the object on which the property changed
237 public void firePropertyChangeEvent(Object object
) {
238 firePropertyChangeEvent(object
, null);
242 * Fires a {@link CdmPropertyChangeEvent} with the given object as source
243 * also containing the originating event
246 * the object on which the property changed
247 * @param originatingEvent
248 * the originating event
250 public void firePropertyChangeEvent(Object object
,
251 PropertyChangeEvent originatingEvent
) {
252 firePropertyChangeEvent(new CdmPropertyChangeEvent(object
,
259 * @see org.eclipse.swt.widgets.Composite#setFocus()
263 public boolean setFocus() {
264 return getClient().setFocus();
271 * org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse
272 * .jface.util.PropertyChangeEvent)
276 public void propertyChange(PropertyChangeEvent event
) {
277 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, event
));
284 * org.eclipse.swt.widgets.Control#setBackground(org.eclipse.swt.graphics
289 public void setBackground(Color color
) {
290 for (ICdmFormElement element
: getElements()) {
291 element
.setBackground(color
);
293 getLayoutComposite().setBackground(color
);
294 super.setBackground(color
);
298 public void setPersistentBackground(Color color
) {
299 persistentBackgroundColor
= color
;
300 setBackground(color
);
304 public Color
getPersistentBackground() {
305 return persistentBackgroundColor
;
315 * a {@link org.eclipse.swt.events.SelectionEvent} object.
317 public void widgetSelected(SelectionEvent e
) {
318 Widget widget
= e
.widget
;
320 if (widget
instanceof Control
) {
321 Control control
= (Control
) widget
;
322 if (checkControlAncestryForWidget(control
)) {
323 if (getEntity() != null) {
324 IStructuredSelection selection
= new StructuredSelection(getEntity());
325 if (selectionProvider
!= null) {
326 selectionProvider
.setSelection(selection
);
333 private boolean checkControlAncestryForWidget(Control control
) {
334 if (control
.equals(this)) {
337 Control parent
= control
.getParent();
338 if (parent
== null) {
341 return checkControlAncestryForWidget(parent
);
348 public void setSelected(boolean selected
) {
350 setBackground(Display
.getCurrent().getSystemColor(
351 SWT
.COLOR_LIST_SELECTION
));
353 setBackground(Display
.getCurrent().getSystemColor(SWT
.COLOR_WHITE
));
359 public void selectionChanged(SelectionChangedEvent event
) {
360 if (event
.getSelection() == CdmFormFactory
.EMPTY_SELECTION
) {
364 IStructuredSelection selection
= (IStructuredSelection
) event
368 Object selectedObject
= selection
.getFirstElement();
370 if (selectedObject
!= null && selectedObject
.equals(getEntity())) {
377 * addSelectionListener
381 * a {@link org.eclipse.swt.events.SelectionListener} object.
383 public void addSelectionListener(SelectionListener listener
) {
384 addListener(SWT
.Selection
, new TypedListener(listener
));
389 * removeSelectionListener
393 * a {@link org.eclipse.swt.events.SelectionListener} object.
395 public void removeSelectionListener(SelectionListener listener
) {
396 removeListener(SWT
.Selection
, listener
);
401 public void addElement(ICdmFormElement element
) {
402 elements
.add(element
);
411 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
414 protected void removeElement(ICdmFormElement element
) {
415 elements
.remove(element
);
424 public void removeElements() {
425 for (ICdmFormElement childElement
: getElements()) {
427 childElement
.removeElements();
429 // unregister selection arbitrator
430 if (childElement
instanceof ISelectableElement
) {
431 ISelectableElement selectableElement
= (ISelectableElement
) childElement
;
432 if (selectableElement
.getSelectionArbitrator() != null) {
433 formFactory
.destroySelectionArbitrator(selectableElement
434 .getSelectionArbitrator());
438 // unregister propertyChangeListener
439 formFactory
.removePropertyChangeListener(childElement
);
441 // dispose of the controls
442 for (Control control
: childElement
.getControls()) {
443 // we added the layoutComposite of the parental element as the
444 // layout composite to this formElement
445 // but we do not want to destroy it.
446 if (control
.equals(childElement
.getLayoutComposite())) {
460 * Getter for the field <code>parentElement</code>.
463 * @return a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
466 public ICdmFormElement
getParentElement() {
467 return parentElement
;
472 * Getter for the field <code>elements</code>.
475 * @return a {@link java.util.Set} object.
478 public Set
<ICdmFormElement
> getElements() {
487 * @return a {@link java.util.Set} object.
490 public Set
<Control
> getControls() {
491 Set
<Control
> controls
= new HashSet
<Control
>();
493 for (Control control
: getChildren()) {
494 controls
.add(control
);
502 public void dispose() {
512 * @return a {@link org.eclipse.swt.widgets.Composite} object.
515 public Composite
getLayoutComposite() {
516 return (Composite
) getClient();
521 public boolean containsFormElement(ICdmFormElement formElement
) {
522 if (formElement
== this) {
525 for (ICdmFormElement element
: getElements()) {
526 boolean contains
= element
.containsFormElement(formElement
);
527 if (contains
== true) {
537 * Getter for the field <code>formFactory</code>.
540 * @return a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
543 public CdmFormFactory
getFormFactory() {
550 * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
558 public void refresh() {
559 // empty default implementation
565 * getConversationHolder
568 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
572 public ConversationHolder
getConversationHolder() {
573 if(AbstractUtility
.getActivePart() instanceof IConversationEnabled
){
574 return ((IConversationEnabled
) AbstractUtility
.getActivePart()).getConversationHolder();
576 if(getParentElement() instanceof RootElement
|| getParentElement() == null){
578 IEditorPart activeEditor
= AbstractUtility
.getActiveEditor();
579 if(activeEditor
instanceof IConversationEnabled
){
580 ConversationHolder conversation
= ((IConversationEnabled
) AbstractUtility
.getActiveEditor()).getConversationHolder();
583 }else if(getParentElement() instanceof IConversationEnabled
){
584 return ((IConversationEnabled
) getParentElement()).getConversationHolder();
586 MessagingUtils
.messageDialog("Could not get conversation for AbstractFormSection",
587 getClass(), "There is an error in the implementation. There should have been an active editor but it wasn't",
588 new IllegalArgumentException());
596 public void update(CdmDataChangeMap changeEvents
) {