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

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