1 package eu
.etaxonomy
.taxeditor
.ui
.element
;
3 import java
.util
.ConcurrentModificationException
;
4 import java
.util
.HashSet
;
8 import org
.eclipse
.core
.runtime
.Assert
;
9 import org
.eclipse
.jface
.util
.IPropertyChangeListener
;
10 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
11 import org
.eclipse
.swt
.SWT
;
12 import org
.eclipse
.swt
.graphics
.Color
;
13 import org
.eclipse
.swt
.widgets
.Composite
;
14 import org
.eclipse
.swt
.widgets
.Control
;
15 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
16 import org
.eclipse
.ui
.forms
.widgets
.Section
;
17 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
18 import org
.eclipse
.wb
.swt
.SWTResourceManager
;
20 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
22 public class AbstractCdmFormElementComposite
extends Composite
implements ICdmFormElement
{
24 protected CdmFormFactory formFactory
;
26 private final Set
<Control
> controls
= new HashSet
<Control
>();
28 private final Set
<ICdmFormElement
> elements
= new HashSet
<ICdmFormElement
>();
29 private final ICdmFormElement parentElement
;
31 private Color persistentBackgroundColor
;
34 * Create the composite.
38 public AbstractCdmFormElementComposite(Composite parent
, final FormToolkit formFactory
, ICdmFormElement parentFormElement
, int style
) {
40 setBackground(SWTResourceManager
.getColor(SWT
.COLOR_WHITE
));
42 this.parentElement
= parentFormElement
;
43 if(formFactory
instanceof CdmFormFactory
){
44 this.formFactory
= (CdmFormFactory
) formFactory
;
46 //TODO what to do when not instance of CdmFormFactory
48 TableWrapLayout twl_layoutComposite
= new TableWrapLayout();
49 twl_layoutComposite
.numColumns
= 2;
50 this.setLayout(twl_layoutComposite
);
52 // addDisposeListener(new DisposeListener() {
54 // public void widgetDisposed(DisposeEvent e) {
55 // formFactory.dispose();
58 // formFactory.adapt(this);
59 // formFactory.paintBordersFor(this);
62 * <p>Getter for the field <code>formFactory</code>.</p>
64 * @return a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
66 public CdmFormFactory
getFormFactory() {
72 * Returns all Controls that are managed by this element
74 * @return a {@link java.util.Set} object.
77 public Set
<Control
> getControls(){
82 * adds the control to the set of controls that are managed by this element
84 * @param child a {@link org.eclipse.swt.widgets.Control} object.
86 protected void addControl(Control child
){
91 * <p>removeControl</p>
93 * @param child a {@link org.eclipse.swt.widgets.Control} object.
95 protected void removeControl(Control child
){
96 controls
.remove(child
);
100 * <p>Getter for the field <code>elements</code>.</p>
102 * @return a {@link java.util.Set} object.
105 public Set
<ICdmFormElement
> getElements(){
110 * <p>Getter for the field <code>parentElement</code>.</p>
112 * @return a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
115 public ICdmFormElement
getParentElement(){
116 return parentElement
;
121 public void addElement(ICdmFormElement element
){
122 elements
.add(element
);
126 * <p>removeElement</p>
128 * @param element a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
130 protected void removeElement(ICdmFormElement element
){
131 elements
.remove(element
);
135 * <p>removeElements</p>
138 public void removeElements(){
139 for(ICdmFormElement childElement
: getElements()){
141 childElement
.removeElements();
143 // unregister selection arbitrator
144 if(childElement
instanceof ISelectableElement
){
145 SelectionArbitrator selectionArbitrator
= ((ISelectableElement
) childElement
).getSelectionArbitrator();
146 if(selectionArbitrator
!= null){
147 formFactory
.destroySelectionArbitrator(selectionArbitrator
);
151 // unregister from property changes
152 formFactory
.removePropertyChangeListener(childElement
);
154 // dispose of the controls
155 removeControls(childElement
);
157 removeControls(this);
161 private void removeControls(ICdmFormElement element
){
162 if(element
instanceof Section
){
163 ((Section
) element
).dispose();
166 for(Control control
: element
.getControls()){
167 // we added the layoutComposite of the parental element as the layout composite to this formElement
168 // but we do not want to destroy it.
169 if(control
.equals(element
.getLayoutComposite())){
180 * <p>Getter for the field <code>layoutComposite</code>.</p>
182 * @return a {@link org.eclipse.swt.widgets.Composite} object.
185 public Composite
getLayoutComposite() {
190 * <p>Setter for the field <code>layoutComposite</code>.</p>
192 * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
194 public void setLayoutComposite(Composite layoutComposite
){
195 //removed layoutComposite
196 // this.layoutComposite = layoutComposite;
200 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#getPropertyChangeListeners()
203 * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
205 * @return a {@link java.util.Set} object.
208 public List
<IPropertyChangeListener
> getPropertyChangeListeners() {
209 return formFactory
.getPropertyChangeListeners();
213 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#setPropertyChangeListeners(org.eclipse.core.runtime.ListenerList)
217 public void setPropertyChangeListeners(List
<IPropertyChangeListener
> propertyChangeListeners
){
218 //TODO: remove method
219 // listeners are already set in factory. no need for them here
223 * @see eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent()
226 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#firePropertyChangeEvent(org.eclipse.jface.util.PropertyChangeEvent)
230 public void firePropertyChangeEvent(CdmPropertyChangeEvent event
) {
231 Assert
.isNotNull(formFactory
.getPropertyChangeListeners(), "Property change listeners are not present");
234 for(Object listener
: formFactory
.getPropertyChangeListeners()){
235 ((IPropertyChangeListener
)listener
).propertyChange(event
);
237 }catch(ConcurrentModificationException e
){
238 // There are two cases that produce a CME.
239 // Described here: http://dev.e-taxonomy.eu/trac/ticket/2363#comment:2
240 // and here: http://dev.e-taxonomy.eu/trac/ticket/2438
241 // Ignoring the CME because nothing bad is happening
242 AbstractUtility
.warn(getClass(), "ConcurrentModificationException. Can be ignored.");
247 * Fires a {@link CdmPropertyChangeEvent} with the given object as source.
249 * @param object the object on which the property changed
251 public void firePropertyChangeEvent(Object object
){
252 firePropertyChangeEvent(object
, null);
256 * Fires a {@link CdmPropertyChangeEvent} with the given object as source also containing the
259 * @param object the object on which the property changed
260 * @param originatingEvent the originating event
262 public void firePropertyChangeEvent(Object object
, PropertyChangeEvent originatingEvent
){
263 firePropertyChangeEvent(new CdmPropertyChangeEvent(object
, originatingEvent
));
270 * This method gets called whenever the toolkit this composite was created with gets a property change notification.
272 * It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite.
273 * Implementations should also check for null PropertyChangeEvents and return immediately in that case.
274 * @see eu.etaxonomy.taxeditor.ui.element.ICdmFormElement#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
277 public void propertyChange(PropertyChangeEvent event
) {
278 // implement in subclasses
283 public boolean containsFormElement(ICdmFormElement formElement
){
284 if(formElement
== this){
287 for(ICdmFormElement element
: getElements()){
288 boolean contains
= element
.containsFormElement(formElement
);
289 if(contains
== true){
299 * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
305 public void refresh() {
306 // empty default implementation
312 public void setBackground(Color color
) {
313 for(ICdmFormElement element
: getElements()){
314 element
.setBackground(color
);
316 super.setBackground(color
);
320 public void setPersistentBackground(Color color
) {
321 persistentBackgroundColor
= color
;
322 setBackground(color
);
326 public Color
getPersistentBackground() {
327 return persistentBackgroundColor
;
330 public Color
getColor(String colorId
){
331 return AbstractUtility
.getColor(colorId
);