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 irrelevant
;
52 * Constructor for AbstractCdmDetailElement.
56 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
59 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
64 public AbstractCdmDetailElement(CdmFormFactory formFactory
,
65 ICdmFormElement formElement
) {
66 super(formFactory
, (ICdmFormElement
) formElement
);
67 // register as property change listener
68 formFactory
.addPropertyChangeListener(this);
72 * Sets the entity and updates controls
77 public void setEntity(T entity
) {
85 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
89 * Getter for the field <code>entity</code>.
94 public T
getEntity() {
99 * Updates all widgets to display the latest data
101 protected void updateContent() {
103 createControls(this, entity
, SWT
.WRAP
);
104 getLayoutComposite().layout();
111 * eu.etaxonomy.taxeditor.forms.ISelectableComposite#setSelected(boolean)
114 public void setSelected(boolean selected
) {
115 Composite section
= getLayoutComposite().getParent();
116 section
.setBackground(selected ? SELECTED
: getPersistentBackground());
120 * Sets all field to the given enablement state except the objects in
123 * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#setEnabled(boolean)
127 * a {@link java.util.Collection} object.
129 public void setEnabled(boolean enabled
, Collection
<Object
> except
) {
130 for (ICdmFormElement element
: getElements()) {
131 if (element
instanceof IEnableableFormElement
) {
132 IEnableableFormElement enableableElement
= (IEnableableFormElement
) element
;
133 if (except
!= null && except
.contains(enableableElement
)) {
134 // enableableElement.setEnabled(enabled);
136 enableableElement
.setEnabled(enabled
);
144 * Setter for the field <code>irrelevant</code>.
150 * a {@link java.util.Collection} object.
152 public void setIrrelevant(boolean irrelevant
, Collection
<Object
> except
) {
153 // logger.warn("Setting " + this.getClass().getSimpleName() +
154 // " to irrelevant state: " + irrelevant);
155 for (ICdmFormElement element
: getElements()) {
156 if (element
instanceof IEnableableFormElement
) {
157 IEnableableFormElement relevantElement
= (IEnableableFormElement
) element
;
158 if (except
!= null && except
.contains(relevantElement
)) {
160 // logger.warn("not setting elements irrelevance: " +
161 // relevantElement.getClass().getSimpleName() + " in :" +
162 // this.getClass().getSimpleName());
164 relevantElement
.setIrrelevant(irrelevant
);
171 public void setEnabled(boolean enabled
) {
172 setEnabled(enabled
, null);
176 public void setIrrelevant(boolean irrelevant
) {
177 this.irrelevant
= irrelevant
;
178 setIrrelevant(irrelevant
, null);
182 * Create all content elements
185 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
192 protected abstract void createControls(ICdmFormElement formElement
,
193 T entity
, int style
);
197 public void propertyChange(PropertyChangeEvent event
) {
202 handleTitleCacheRelevantChange(event
);
204 Object eventSource
= event
.getSource();
206 if (eventSource
instanceof ICdmFormElement
) {
207 ICdmFormElement eventElement
= (ICdmFormElement
) eventSource
;
208 ICdmFormElement eventElementContainer
= eventElement
211 if (eventElementContainer
== this) {
212 if (event
instanceof CdmPropertyChangeEvent
) {
213 if (((CdmPropertyChangeEvent
) event
).hasException()) {
214 handleException((CdmPropertyChangeEvent
) event
);
218 // call specific handler implementation
219 handleEvent(eventSource
);
221 firePropertyChangeEvent(this, event
);
222 // update possible parents
223 updateParentSection();
228 protected void handleTitleCacheRelevantChange(PropertyChangeEvent event
) {
229 boolean isRelevant
= getEntity() instanceof TaxonNameBase
230 || getEntity() instanceof TaxonBase
;
231 isRelevant
&= this instanceof AbstractIdentifiableEntityDetailElement
;
234 ((AbstractIdentifiableEntityDetailElement
) this)
235 .updateToggleableCacheField();
236 updateParentSection();
240 private void updateParentSection() {
241 if (getParentElement() instanceof AbstractCdmDetailSection
) {
242 ((AbstractCdmDetailSection
) getParentElement()).updateTitle();
247 * Gets called when the source of the event is a child widget of this
251 * a {@link java.lang.Object} object.
253 public abstract void handleEvent(Object eventSource
);
262 * {@link eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent}
265 public void handleException(CdmPropertyChangeEvent event
) {
266 // override this in subclasses if you want to deal with the error
267 StoreUtil
.error(event
.getSource().getClass(), event
.getException());
277 public boolean isIrrelevant() {
283 * getConversationHolder
286 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
289 public ConversationHolder
getConversationHolder() {
290 if (getParentElement() instanceof IConversationEnabled
) {
291 return ((IConversationEnabled
) getParentElement())
292 .getConversationHolder();
294 throw new IllegalArgumentException(
295 "Parent element should be IConversationEnabled");
299 public void update(CdmDataChangeMap changeEvents
) {