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
.section
;
13 import java
.util
.Collection
;
15 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
16 import org
.eclipse
.swt
.SWT
;
17 import org
.eclipse
.swt
.widgets
.Composite
;
19 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
20 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
21 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
22 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
23 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
24 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
25 import eu
.etaxonomy
.taxeditor
.ui
.element
.AbstractCdmFormElement
;
26 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmFormFactory
;
27 import eu
.etaxonomy
.taxeditor
.ui
.element
.CdmPropertyChangeEvent
;
28 import eu
.etaxonomy
.taxeditor
.ui
.element
.ICdmFormElement
;
29 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEnableableFormElement
;
30 import eu
.etaxonomy
.taxeditor
.ui
.element
.IEntityElement
;
31 import eu
.etaxonomy
.taxeditor
.ui
.element
.ISelectable
;
35 * Abstract AbstractCdmDetailElement class.
39 * @created Feb 26, 2010
42 public abstract class AbstractCdmDetailElement
<T
> extends
43 AbstractCdmFormElement
implements IEntityElement
<T
>,
44 IEnableableFormElement
, IConversationEnabled
, ISelectable
{
48 private boolean enabled
;
50 private boolean irrelevant
;
54 * Constructor for AbstractCdmDetailElement.
58 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
61 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
66 public AbstractCdmDetailElement(CdmFormFactory formFactory
,
67 ICdmFormElement formElement
) {
68 super(formFactory
, (ICdmFormElement
) formElement
);
69 // register as property change listener
70 formFactory
.addPropertyChangeListener(this);
74 * Sets the entity and updates controls
79 public void setEntity(T entity
) {
87 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
91 * Getter for the field <code>entity</code>.
96 public T
getEntity() {
101 * Updates all widgets to display the latest data
103 protected void updateContent() {
105 createControls(this, entity
, SWT
.WRAP
);
106 getLayoutComposite().layout();
113 * eu.etaxonomy.taxeditor.forms.ISelectableComposite#setSelected(boolean)
116 public void setSelected(boolean selected
) {
117 Composite section
= getLayoutComposite().getParent();
118 section
.setBackground(selected ? SELECTED
: getPersistentBackground());
122 * Sets all field to the given enablement state except the objects in
125 * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#setEnabled(boolean)
129 * a {@link java.util.Collection} object.
131 public void setEnabled(boolean enabled
, Collection
<Object
> except
) {
132 for (ICdmFormElement element
: getElements()) {
133 if (element
instanceof IEnableableFormElement
) {
134 IEnableableFormElement enableableElement
= (IEnableableFormElement
) element
;
135 if (except
!= null && except
.contains(enableableElement
)) {
136 // enableableElement.setEnabled(enabled);
138 enableableElement
.setEnabled(enabled
);
146 * Setter for the field <code>irrelevant</code>.
152 * a {@link java.util.Collection} object.
154 public void setIrrelevant(boolean irrelevant
, Collection
<Object
> except
) {
155 // logger.warn("Setting " + this.getClass().getSimpleName() +
156 // " to irrelevant state: " + irrelevant);
157 for (ICdmFormElement element
: getElements()) {
158 if (element
instanceof IEnableableFormElement
) {
159 IEnableableFormElement relevantElement
= (IEnableableFormElement
) element
;
160 if (except
!= null && except
.contains(relevantElement
)) {
162 // logger.warn("not setting elements irrelevance: " +
163 // relevantElement.getClass().getSimpleName() + " in :" +
164 // this.getClass().getSimpleName());
166 relevantElement
.setIrrelevant(irrelevant
);
173 public void setEnabled(boolean enabled
) {
174 this.enabled
= enabled
;
175 setEnabled(enabled
, null);
179 public void setIrrelevant(boolean irrelevant
) {
180 this.irrelevant
= irrelevant
;
181 setIrrelevant(irrelevant
, null);
185 * Create all content elements
188 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
195 protected abstract void createControls(ICdmFormElement formElement
,
196 T entity
, int style
);
200 public void propertyChange(PropertyChangeEvent event
) {
205 handleTitleCacheRelevantChange(event
);
207 Object eventSource
= event
.getSource();
209 if (eventSource
instanceof ICdmFormElement
) {
210 ICdmFormElement eventElement
= (ICdmFormElement
) eventSource
;
211 ICdmFormElement eventElementContainer
= eventElement
214 if (eventElementContainer
== this) {
215 if (event
instanceof CdmPropertyChangeEvent
) {
216 if (((CdmPropertyChangeEvent
) event
).hasException()) {
217 handleException((CdmPropertyChangeEvent
) event
);
221 // call specific handler implementation
222 handleEvent(eventSource
);
224 firePropertyChangeEvent(this, event
);
225 // update possible parents
226 updateParentSection();
231 protected void handleTitleCacheRelevantChange(PropertyChangeEvent event
) {
232 boolean isRelevant
= getEntity() instanceof TaxonNameBase
233 || getEntity() instanceof TaxonBase
;
234 isRelevant
&= this instanceof AbstractIdentifiableEntityDetailElement
;
237 ((AbstractIdentifiableEntityDetailElement
) this)
238 .updateToggleableCacheField();
239 updateParentSection();
243 private void updateParentSection() {
244 if (getParentElement() instanceof AbstractCdmDetailSection
) {
245 ((AbstractCdmDetailSection
) getParentElement()).updateTitle();
250 * Gets called when the source of the event is a child widget of this
254 * a {@link java.lang.Object} object.
256 public abstract void handleEvent(Object eventSource
);
265 * {@link eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent}
268 public void handleException(CdmPropertyChangeEvent event
) {
269 // override this in subclasses if you want to deal with the error
270 StoreUtil
.error(event
.getSource().getClass(), event
.getException());
280 public boolean isIrrelevant() {
286 * getConversationHolder
289 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
292 public ConversationHolder
getConversationHolder() {
293 if (getParentElement() instanceof IConversationEnabled
) {
294 return ((IConversationEnabled
) getParentElement())
295 .getConversationHolder();
297 throw new IllegalArgumentException(
298 "Parent element should be IConversationEnabled");
302 public void update(CdmDataChangeMap changeEvents
) {