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