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
.persistence
.hibernate
.CdmDataChangeMap
;
22 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
23 import eu
.etaxonomy
.taxeditor
.ui
.forms
.AbstractCdmFormElement
;
24 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmFormFactory
;
25 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmPropertyChangeEvent
;
26 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ICdmFormElement
;
27 import eu
.etaxonomy
.taxeditor
.ui
.forms
.IEnableableFormElement
;
28 import eu
.etaxonomy
.taxeditor
.ui
.forms
.IEntityElement
;
29 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ISelectable
;
32 * <p>Abstract AbstractCdmDetailElement class.</p>
35 * @created Feb 26, 2010
38 public abstract class AbstractCdmDetailElement
<T
> extends
39 AbstractCdmFormElement
implements IEntityElement
<T
>, ISelectable
, IEnableableFormElement
, IConversationEnabled
{
43 private boolean enabled
;
45 private boolean irrelevant
;
48 * <p>Constructor for AbstractCdmDetailElement.</p>
50 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
51 * @param formElement a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
52 * @param <T> a T object.
54 public AbstractCdmDetailElement(CdmFormFactory formFactory
,
55 ICdmFormElement formElement
) {
56 super(formFactory
, (ICdmFormElement
) formElement
);
57 // register as property change listener
58 formFactory
.addPropertyChangeListener(this);
62 * Sets the entity and updates controls
64 * @param entity a T object.
66 public void setEntity(T entity
){
73 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
76 * <p>Getter for the field <code>entity</code>.</p>
80 public T
getEntity() {
85 * Updates all widgets to display the latest data
87 protected void updateContent(){
89 createControls(this, entity
, SWT
.WRAP
);
90 getLayoutComposite().layout();
95 * @see eu.etaxonomy.taxeditor.forms.ISelectableComposite#setSelected(boolean)
98 public void setSelected(boolean selected
) {
99 Composite section
= getLayoutComposite().getParent();
100 section
.setBackground(getColor(selected
));
104 * Sets all field to the given enablement state except the objects in collection except
106 * @see eu.etaxonomy.taxeditor.ui.forms.IEnableableFormElement#setEnabled(boolean)
107 * @param enabled a boolean.
108 * @param except a {@link java.util.Collection} object.
110 public void setEnabled(boolean enabled
, Collection
<Object
> except
) {
111 for(ICdmFormElement element
: getElements()){
112 if(element
instanceof IEnableableFormElement
){
113 IEnableableFormElement enableableElement
= (IEnableableFormElement
) element
;
114 if(except
!= null && except
.contains(enableableElement
)){
115 // enableableElement.setEnabled(enabled);
117 enableableElement
.setEnabled(enabled
);
124 * <p>Setter for the field <code>irrelevant</code>.</p>
126 * @param irrelevant a boolean.
127 * @param except a {@link java.util.Collection} object.
129 public void setIrrelevant(boolean irrelevant
, Collection
<Object
> except
){
130 //logger.warn("Setting " + this.getClass().getSimpleName() + " to irrelevant state: " + irrelevant);
131 for(ICdmFormElement element
: getElements()){
132 if(element
instanceof IEnableableFormElement
){
133 IEnableableFormElement relevantElement
= (IEnableableFormElement
) element
;
134 if(except
!= null && except
.contains(relevantElement
)){
136 //logger.warn("not setting elements irrelevance: " + relevantElement.getClass().getSimpleName() + " in :" + this.getClass().getSimpleName());
138 relevantElement
.setIrrelevant(irrelevant
);
145 public void setEnabled(boolean enabled
) {
146 this.enabled
= enabled
;
147 setEnabled(enabled
, null);
151 public void setIrrelevant(boolean irrelevant
) {
152 this.irrelevant
= irrelevant
;
153 setIrrelevant(irrelevant
, null);
157 * Create all content elements
159 * @param formElement a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
160 * @param entity a T object.
161 * @param style a int.
163 protected abstract void createControls(ICdmFormElement formElement
, T entity
, int style
);
167 public void propertyChange(PropertyChangeEvent event
) {
172 Object eventSource
= event
.getSource();
174 if(eventSource
instanceof ICdmFormElement
){
175 ICdmFormElement eventElement
= (ICdmFormElement
) eventSource
;
176 ICdmFormElement eventElementContainer
= eventElement
.getParentElement();
177 if (eventElementContainer
== this){
178 if(event
instanceof CdmPropertyChangeEvent
){
179 if(((CdmPropertyChangeEvent
) event
).hasException()){
180 handleException((CdmPropertyChangeEvent
) event
);
185 handleEvent(eventSource
);
186 if(getParentElement() instanceof AbstractCdmDetailSection
)
187 ((AbstractCdmDetailSection
)getParentElement()).updateTitle();
195 * @param eventSource a {@link java.lang.Object} object.
197 public abstract void handleEvent(Object eventSource
);
200 * <p>handleException</p>
202 * @param event a {@link eu.etaxonomy.taxeditor.ui.forms.CdmPropertyChangeEvent} object.
204 public void handleException(CdmPropertyChangeEvent event
){
205 //override this in subclasses if you want to deal with the error
206 StoreUtil
.error(event
.getSource().getClass(), event
.getException());
210 * <p>isIrrelevant</p>
214 public boolean isIrrelevant() {
219 * <p>getConversationHolder</p>
221 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
223 public ConversationHolder
getConversationHolder() {
224 if(getParentElement() instanceof IConversationEnabled
){
225 return ((IConversationEnabled
) getParentElement()).getConversationHolder();
227 throw new IllegalArgumentException("Parent element should be IConversationEnabled");
231 public void update(CdmDataChangeMap changeEvents
) {}