eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/element/AbstractCdmFormElement.java

   1 /**
   2  *
   3  */
   4 package eu.etaxonomy.taxeditor.ui.element;
   5
   6 import java.util.ConcurrentModificationException;
   7 import java.util.HashSet;
   8 import java.util.List;
   9 import java.util.Set;
  10
  11 import org.eclipse.core.runtime.Assert;
  12 import org.eclipse.jface.util.IPropertyChangeListener;
  13 import org.eclipse.jface.util.PropertyChangeEvent;
  14 import org.eclipse.swt.graphics.Color;
  15 import org.eclipse.swt.widgets.Composite;
  16 import org.eclipse.swt.widgets.Control;
  17 import org.eclipse.ui.forms.widgets.Section;
  18
  19 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  20
  21 /**
  22  * <p>Abstract AbstractCdmFormElement class.</p>
  23  *
  24  * @author n.hoffmann
  25  * @version $Id: $
  26  */
  27 public abstract class AbstractCdmFormElement implements ICdmFormElement {
  28
  29         protected CdmFormFactory formFactory;
  30
  31         private List<IPropertyChangeListener> propertyChangeListeners;
  32
  33         private Composite layoutComposite;
  34
  35         private final Set<Control> controls = new HashSet<Control>();
  36
  37         private final Set<ICdmFormElement> elements = new HashSet<ICdmFormElement>();
  38         private ICdmFormElement parentElement;
  39
  40         private Color persistentBackgroundColor;
  41
  42
  43         /**
  44          * <p>Constructor for AbstractCdmFormElement.</p>
  45          *
  46          * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
  47          * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
  48          */
  49         protected AbstractCdmFormElement(CdmFormFactory formFactory, Composite layoutComposite){
  50                 this.layoutComposite = layoutComposite;
  51                 this.formFactory = formFactory;
  52         }
  53
  54         /**
  55          * <p>Constructor for AbstractCdmFormElement.</p>
  56          *
  57          * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
  58          * @param formElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
  59          */
  60         public AbstractCdmFormElement(CdmFormFactory formFactory, ICdmFormElement formElement) {
  61                 this(formFactory, formElement.getLayoutComposite());
  62                 this.parentElement = formElement;
  63 //              addControl(layoutComposite);
  64         }
  65
  66         /**
  67          * <p>Getter for the field <code>formFactory</code>.</p>
  68          *
  69          * @return a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
  70          */
  71         public CdmFormFactory getFormFactory() {
  72                 return formFactory;
  73         }
  74
  75         /**
  76          * Delegates the focus to <code>this</code> elements main input control
  77          */
  78         public void setFocus(){
  79                 // Override in subclasses where needed
  80         }
  81
  82         /**
  83          * Returns all Controls that are managed by this element
  84          *
  85          * @return a {@link java.util.Set} object.
  86          */
  87         @Override
  88     public Set<Control> getControls(){
  89                 return controls;
  90         }
  91
  92         /**
  93          * adds the control to the set of controls that are managed by this element
  94          *
  95          * @param child a {@link org.eclipse.swt.widgets.Control} object.
  96          */
  97         protected void addControl(Control child){
  98                 controls.add(child);
  99         }
 100
 101         /**
 102          * <p>removeControl</p>
 103          *
 104          * @param child a {@link org.eclipse.swt.widgets.Control} object.
 105          */
 106         protected void removeControl(Control child){
 107                 controls.remove(child);
 108         }
 109
 110         /**
 111          * <p>Getter for the field <code>elements</code>.</p>
 112          *
 113          * @return a {@link java.util.Set} object.
 114          */
 115         @Override
 116     public Set<ICdmFormElement> getElements(){
 117                 return elements;
 118         }
 119
 120         /**
 121          * <p>Getter for the field <code>parentElement</code>.</p>
 122          *
 123          * @return a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
 124          */
 125         @Override
 126     public ICdmFormElement getParentElement(){
 127                 return parentElement;
 128         }
 129
 130         /** {@inheritDoc} */
 131         @Override
 132     public void addElement(ICdmFormElement element){
 133                 elements.add(element);
 134         }
 135
 136         /**
 137          * <p>removeElement</p>
 138          *
 139          * @param element a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
 140          */
 141         protected void removeElement(ICdmFormElement element){
 142                 elements.remove(element);
 143         }
 144
 145         /**
 146          * <p>removeElements</p>
 147          */
 148         @Override
 149     public void removeElements(){
 150                 for(ICdmFormElement childElement : getElements()){
 151                         // recursion
 152                         childElement.removeElements();
 153
 154                         // unregister selection arbitrator
 155                         if(childElement instanceof ISelectableElement){
 156                                 SelectionArbitrator selectionArbitrator = ((ISelectableElement) childElement).getSelectionArbitrator();
 157                                 if(selectionArbitrator != null){
 158                                         formFactory.destroySelectionArbitrator(selectionArbitrator);
 159                                 }
 160                         }
 161
 162                         // unregister from property changes
 163                         formFactory.removePropertyChangeListener(childElement);
 164
 165                         // dispose of the controls
 166                         removeControls(childElement);
 167                 }
 168                 removeControls(this);
 169                 elements.clear();
 170         }
 171
 172         private void removeControls(ICdmFormElement element){
 173                 if(element instanceof Section){
 174                         ((Section) element).dispose();
 175                         element = null;
 176                 }else{
 177                         for(Control control : element.getControls()){
 178                                 // we added the layoutComposite of the parental element as the layout composite to this formElement
 179                                 // but we do not want to destroy it.
 180                                 if(control.equals(element.getLayoutComposite())){
 181                                         continue;
 182                                 }else{
 183                                         control.dispose();
 184                                         control = null;
 185                                 }
 186                         }
 187                 }
 188         }
 189
 190         /**
 191          * <p>Getter for the field <code>layoutComposite</code>.</p>
 192          *
 193          * @return a {@link org.eclipse.swt.widgets.Composite} object.
 194          */
 195         @Override
 196     public Composite getLayoutComposite() {
 197                 return layoutComposite;
 198         }
 199
 200         /**
 201          * <p>Setter for the field <code>layoutComposite</code>.</p>
 202          *
 203          * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
 204          */
 205         public void setLayoutComposite(Composite layoutComposite){
 206                 this.layoutComposite = layoutComposite;
 207         }
 208
 209         /* (non-Javadoc)
 210          * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#getPropertyChangeListeners()
 211          */
 212         /**
 213          * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
 214          *
 215          * @return a {@link java.util.Set} object.
 216          */
 217         @Override
 218     public List<IPropertyChangeListener> getPropertyChangeListeners() {
 219                 return propertyChangeListeners;
 220         }
 221
 222         /* (non-Javadoc)
 223          * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#setPropertyChangeListeners(org.eclipse.core.runtime.ListenerList)
 224          */
 225         /** {@inheritDoc} */
 226         @Override
 227     public void setPropertyChangeListeners(List<IPropertyChangeListener> propertyChangeListeners){
 228                 this.propertyChangeListeners = propertyChangeListeners;
 229         }
 230
 231         /* (non-Javadoc)
 232          * @see eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent()
 233          */
 234         /* (non-Javadoc)
 235          * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#firePropertyChangeEvent(org.eclipse.jface.util.PropertyChangeEvent)
 236          */
 237         /** {@inheritDoc} */
 238         @Override
 239     public void firePropertyChangeEvent(CdmPropertyChangeEvent event) {
 240                 Assert.isNotNull(propertyChangeListeners, "Property change listeners are not present");
 241
 242                 try{
 243                         for(Object listener : propertyChangeListeners){
 244                                 ((IPropertyChangeListener)listener).propertyChange(event);
 245                         }
 246                 }catch(ConcurrentModificationException e){
 247                         // There are two cases that produce a CME.
 248                         // Described here: http://dev.e-taxonomy.eu/trac/ticket/2363#comment:2
 249                         // and here: http://dev.e-taxonomy.eu/trac/ticket/2438
 250                         // Ignoring the CME because nothing bad is happening
 251                         AbstractUtility.warn(getClass(), "ConcurrentModificationException. Can be ignored.");
 252                 }
 253         }
 254
 255         /**
 256          * Fires a {@link CdmPropertyChangeEvent} with the given object as source.
 257          *
 258          * @param object the object on which the property changed
 259          */
 260         public void firePropertyChangeEvent(Object object){
 261                 firePropertyChangeEvent(object, null);
 262         }
 263
 264         /**
 265          * Fires a {@link CdmPropertyChangeEvent} with the given object as source also containing the
 266          * originating event
 267          *
 268          * @param object the object on which the property changed
 269          * @param originatingEvent the originating event
 270          */
 271         public void firePropertyChangeEvent(Object object, PropertyChangeEvent originatingEvent){
 272                 firePropertyChangeEvent(new CdmPropertyChangeEvent(object, originatingEvent));
 273         }
 274
 275
 276         /**
 277          * {@inheritDoc}
 278          *
 279          * This method gets called whenever the toolkit this composite was created with gets a property change notification.
 280          *
 281          * It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite.
 282          * Implementations should also check for null PropertyChangeEvents and return immediately in that case.
 283          * @see eu.etaxonomy.taxeditor.ui.element.ICdmFormElement#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
 284          */
 285         @Override
 286     public void propertyChange(PropertyChangeEvent event) {
 287                 // implement in subclasses
 288         }
 289
 290         /** {@inheritDoc} */
 291         @Override
 292     public boolean containsFormElement(ICdmFormElement formElement){
 293                 if(formElement == this){
 294                         return true;
 295                 }else{
 296                         for(ICdmFormElement element : getElements()){
 297                                 boolean contains = element.containsFormElement(formElement);
 298                                 if(contains == true){
 299                                         return true;
 300                                 }
 301                         }
 302                         return false;
 303                 }
 304         }
 305
 306         /*
 307          * (non-Javadoc)
 308          * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
 309          */
 310         /**
 311          * <p>refresh</p>
 312          */
 313         @Override
 314     public void refresh() {
 315                 // empty default implementation
 316         }
 317
 318
 319         /** {@inheritDoc} */
 320         @Override
 321         public void setBackground(Color color) {
 322                 for(ICdmFormElement element : getElements()){
 323                         element.setBackground(color);
 324                 }
 325         }
 326
 327         @Override
 328         public void setPersistentBackground(Color color) {
 329                 persistentBackgroundColor = color;
 330                 setBackground(color);
 331         }
 332
 333         @Override
 334         public Color getPersistentBackground() {
 335                 return persistentBackgroundColor;
 336         }
 337
 338         public Color getColor(String colorId){
 339                 return AbstractUtility.getColor(colorId);
 340         }
 341 }