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
;
34 * Abstract AbstractCdmDetailElement class.
38 * @created Feb 26, 2010
41 public abstract class AbstractCdmDetailElement
<T
> extends AbstractCdmFormElement
implements IEntityElement
<T
>, IEnableableFormElement
, IConversationEnabled
{
45 private boolean irrelevant
;
49 * Constructor for AbstractCdmDetailElement.
53 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
56 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
61 public AbstractCdmDetailElement(CdmFormFactory formFactory
,
62 ICdmFormElement formElement
) {
63 super(formFactory
, formElement
);
64 // register as property change listener
65 formFactory
.addPropertyChangeListener(this);
69 * Sets the entity and updates controls
74 public void setEntity(T entity
) {
82 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
86 * Getter for the field <code>entity</code>.
92 public T
getEntity() {
97 * Updates all widgets to display the latest data
99 protected void updateContent() {
101 createControls(this, entity
, SWT
.WRAP
);
102 getLayoutComposite().layout();
109 * eu.etaxonomy.taxeditor.forms.ISelectableComposite#setSelected(boolean)
113 public void setSelected(boolean selected
) {
114 Composite section
= getLayoutComposite().getParent();
115 section
.setBackground(selected ? SELECTED
: getPersistentBackground());
119 * Sets all field to the given enablement state except the objects in
122 * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#setEnabled(boolean)
126 * a {@link java.util.Collection} object.
128 public void setEnabled(boolean enabled
, Collection
<Object
> except
) {
129 for (ICdmFormElement element
: getElements()) {
130 if (element
instanceof IEnableableFormElement
) {
131 IEnableableFormElement enableableElement
= (IEnableableFormElement
) element
;
132 if (except
!= null && except
.contains(enableableElement
)) {
133 // enableableElement.setEnabled(enabled);
135 enableableElement
.setEnabled(enabled
);
143 * Setter for the field <code>irrelevant</code>.
149 * a {@link java.util.Collection} object.
151 public void setIrrelevant(boolean irrelevant
, Collection
<Object
> except
) {
152 // logger.warn("Setting " + this.getClass().getSimpleName() +
153 // " to irrelevant state: " + irrelevant);
154 for (ICdmFormElement element
: getElements()) {
155 if (element
instanceof IEnableableFormElement
) {
156 IEnableableFormElement relevantElement
= (IEnableableFormElement
) element
;
157 if (except
!= null && except
.contains(relevantElement
)) {
159 // logger.warn("not setting elements irrelevance: " +
160 // relevantElement.getClass().getSimpleName() + " in :" +
161 // this.getClass().getSimpleName());
163 relevantElement
.setIrrelevant(irrelevant
);
171 public void setEnabled(boolean enabled
) {
172 setEnabled(enabled
, null);
177 public void setIrrelevant(boolean irrelevant
) {
178 this.irrelevant
= irrelevant
;
179 setIrrelevant(irrelevant
, null);
183 * Create all content elements
186 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
193 protected abstract void createControls(ICdmFormElement formElement
,
194 T entity
, int style
);
198 public void propertyChange(PropertyChangeEvent event
) {
203 handleTitleCacheRelevantChange(event
);
205 Object eventSource
= event
.getSource();
207 if (eventSource
instanceof ICdmFormElement
) {
208 ICdmFormElement eventElement
= (ICdmFormElement
) eventSource
;
209 ICdmFormElement eventElementContainer
= eventElement
212 if (eventElementContainer
== this) {
213 if (event
instanceof CdmPropertyChangeEvent
) {
214 if (((CdmPropertyChangeEvent
) event
).hasException()) {
215 handleException((CdmPropertyChangeEvent
) event
);
219 // call specific handler implementation
220 handleEvent(eventSource
);
222 firePropertyChangeEvent(this, event
);
223 // update possible parents
224 updateParentSection();
229 protected void handleTitleCacheRelevantChange(PropertyChangeEvent event
) {
230 boolean isRelevant
= getEntity() instanceof TaxonNameBase
231 || getEntity() instanceof TaxonBase
;
232 isRelevant
&= this instanceof AbstractIdentifiableEntityDetailElement
;
235 ((AbstractIdentifiableEntityDetailElement
) this)
236 .updateToggleableCacheField();
237 updateParentSection();
241 private void updateParentSection() {
242 if (getParentElement() instanceof AbstractCdmDetailSection
) {
243 ((AbstractCdmDetailSection
) getParentElement()).updateTitle();
248 * Gets called when the source of the event is a child widget of this
252 * a {@link java.lang.Object} object.
254 public abstract void handleEvent(Object eventSource
);
263 * {@link eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent}
266 public void handleException(CdmPropertyChangeEvent event
) {
267 // override this in subclasses if you want to deal with the error
268 StoreUtil
.error(event
.getSource().getClass(), event
.getException());
278 public boolean isIrrelevant() {
284 * getConversationHolder
287 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
291 public ConversationHolder
getConversationHolder() {
292 if (getParentElement() instanceof IConversationEnabled
) {
293 return ((IConversationEnabled
) getParentElement())
294 .getConversationHolder();
296 throw new IllegalArgumentException(
297 "Parent element should be IConversationEnabled");
302 public void update(CdmDataChangeMap changeEvents
) {