performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / forms / AbstractCdmFormElement.java

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractCdmFormElement.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractCdmFormElement.java
index 3d46f6851f21feeee6db568d6679df3d33927bc0..d2f8639f57cc47bfe034c49895ece88c0e3a2255 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractCdmFormElement.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractCdmFormElement.java
@@ -15,8 +15,10 @@ import org.eclipse.swt.widgets.Control;
 import org.eclipse.ui.forms.widgets.Section;
 
 /**
- * @author n.hoffmann
+ * <p>Abstract AbstractCdmFormElement class.</p>
  *
+ * @author n.hoffmann
+ * @version $Id: $
  */
 public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter, ICdmFormElement, ISelectable {
 
@@ -32,14 +34,22 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        private ICdmFormElement parentElement;
        
        
+       /**
+        * <p>Constructor for AbstractCdmFormElement.</p>
+        *
+        * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
+        */
        protected AbstractCdmFormElement(CdmFormFactory formFactory, Composite layoutComposite){
                this.layoutComposite = layoutComposite;
                this.formFactory = formFactory;
        }
        
        /**
-        * @param parent
-        * @param style
+        * <p>Constructor for AbstractCdmFormElement.</p>
+        *
+        * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        * @param formElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
         */
        public AbstractCdmFormElement(CdmFormFactory formFactory, ICdmFormElement formElement) {
                this(formFactory, formElement.getLayoutComposite());
@@ -47,10 +57,16 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
 //             addControl(layoutComposite);
        }
        
+       /**
+        * <p>Getter for the field <code>formFactory</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        */
        public CdmFormFactory getFormFactory() {
                return formFactory;
        }
        
+       /** {@inheritDoc} */
        public Color getColor(boolean selected) {
                return selected ? SELECTED : NOT_SELECTED;
        }
@@ -63,8 +79,9 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        }
        
        /**
-        * Returns all Controls that are managed by this element 
-        * @return
+        * Returns all Controls that are managed by this element
+        *
+        * @return a {@link java.util.Set} object.
         */
        public Set<Control> getControls(){
                return controls;
@@ -72,32 +89,57 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        
        /**
         * adds the control to the set of controls that are managed by this element
-        * @param child
+        *
+        * @param child a {@link org.eclipse.swt.widgets.Control} object.
         */
        protected void addControl(Control child){
                controls.add(child);
        }
        
+       /**
+        * <p>removeControl</p>
+        *
+        * @param child a {@link org.eclipse.swt.widgets.Control} object.
+        */
        protected void removeControl(Control child){
                controls.remove(child);
        }
        
+       /**
+        * <p>Getter for the field <code>elements</code>.</p>
+        *
+        * @return a {@link java.util.Set} object.
+        */
        public Set<ICdmFormElement> getElements(){
                return elements;
        }
        
+       /**
+        * <p>Getter for the field <code>parentElement</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        */
        public ICdmFormElement getParentElement(){
                return parentElement;
        }
        
+       /** {@inheritDoc} */
        public void addElement(ICdmFormElement element){
                elements.add(element);
        }
        
+       /**
+        * <p>removeElement</p>
+        *
+        * @param element a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        */
        protected void removeElement(ICdmFormElement element){
                elements.remove(element);
        }
        
+       /**
+        * <p>removeElements</p>
+        */
        public void removeElements(){
                for(ICdmFormElement childElement : getElements()){
                        // recursion
@@ -140,10 +182,20 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
                }
        }
        
+       /**
+        * <p>Getter for the field <code>layoutComposite</code>.</p>
+        *
+        * @return a {@link org.eclipse.swt.widgets.Composite} object.
+        */
        public Composite getLayoutComposite() {
                return layoutComposite;
        }
        
+       /**
+        * <p>Setter for the field <code>layoutComposite</code>.</p>
+        *
+        * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
+        */
        public void setLayoutComposite(Composite layoutComposite){
                this.layoutComposite = layoutComposite;
        }
@@ -151,6 +203,11 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#getPropertyChangeListeners()
         */
+       /**
+        * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
+        *
+        * @return a {@link java.util.Set} object.
+        */
        public Set<IPropertyChangeListener> getPropertyChangeListeners() {
                return propertyChangeListeners;
        }
@@ -158,6 +215,7 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#setPropertyChangeListeners(org.eclipse.core.runtime.ListenerList)
         */
+       /** {@inheritDoc} */
        public void setPropertyChangeListeners(Set<IPropertyChangeListener> propertyChangeListeners){
                this.propertyChangeListeners = propertyChangeListeners;
        }
@@ -168,6 +226,7 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#firePropertyChangeEvent(org.eclipse.jface.util.PropertyChangeEvent)
         */
+       /** {@inheritDoc} */
        public void firePropertyChangeEvent(CdmPropertyChangeEvent event) {
                Assert.isNotNull(propertyChangeListeners, "Property change listeners are not present");
                for(Object listener : propertyChangeListeners){
@@ -177,22 +236,19 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
        
 
        /**
+        * {@inheritDoc}
+        *
         * This method gets called whenever the toolkit this composite was created with gets a property change notification.
-        * 
+        *
         * It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite.
         * Implementations should also check for null PropertyChangeEvents and return immediately in that case.
-        * 
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
         */
        public void propertyChange(PropertyChangeEvent event) {
                // implement in subclasses
        }
        
-       /**
-        * 
-        * @param formElement
-        * @return
-        */
+       /** {@inheritDoc} */
        public boolean containsFormElement(ICdmFormElement formElement){
                if(formElement == this){
                        return true;
@@ -211,10 +267,14 @@ public abstract class AbstractCdmFormElement implements IPropertyChangeEmitter,
         * (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
         */
+       /**
+        * <p>refresh</p>
+        */
        public void refresh() {
                // empty default implementation 
        }
        
+       /** {@inheritDoc} */
        @Override
        public void setBackground(Color color) {
                for(ICdmFormElement element : getElements()){