performed javacscript:fix and worked on documentation

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

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractFormSection.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractFormSection.java
index 13147e6a9f011ad6a51b4c4e014e8ebf21ab33c7..c9886afaf96df96af59a520b7e35a5c115ff8fd0 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractFormSection.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractFormSection.java
@@ -33,7 +33,8 @@ import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
 
 /**
- * 
+ * <p>Abstract AbstractFormSection class.</p>
+ *
  * @author n.hoffmann
  * @created Feb 22, 2010
  * @version 1.0
@@ -56,9 +57,13 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        private ConversationHolder conversation;
 
        /**
+        * <p>Constructor for AbstractFormSection.</p>
+        *
         * @param conversation TODO
-        * @param style
-        * @param parent
+        * @param style a int.
+        * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        * @param <ENTITY> a ENTITY object.
         */
        protected AbstractFormSection(CdmFormFactory formFactory, ConversationHolder conversation, ICdmFormElement parentElement, int style) {
                super(parentElement.getLayoutComposite(), style);
@@ -83,23 +88,39 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
                this.setClient(client);
        }
 
+       /**
+        * <p>Constructor for AbstractFormSection.</p>
+        *
+        * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        * @param selectionProvider a {@link org.eclipse.jface.viewers.ISelectionProvider} object.
+        * @param style a int.
+        */
        protected AbstractFormSection(CdmFormFactory formFactory, ConversationHolder conversation, ICdmFormElement parentElement, ISelectionProvider selectionProvider, int style){
                this(formFactory, conversation, parentElement, style);
                this.selectionProvider = selectionProvider;
        }
        
+       /**
+        * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
+        *
+        * @return a {@link java.util.Set} object.
+        */
        public Set<IPropertyChangeListener> getPropertyChangeListeners() {
                return propertyChangeListeners;
        }
        
+       /** {@inheritDoc} */
        public void setPropertyChangeListeners(
                        Set<IPropertyChangeListener> propertyChangeListeners) {
                this.propertyChangeListeners = propertyChangeListeners;
        }
 
        /**
-        * 
-        * @param entity
+        * <p>Setter for the field <code>entity</code>.</p>
+        *
+        * @param entity a ENTITY object.
         */
        public void setEntity(ENTITY entity){
                this.entity = entity;
@@ -109,14 +130,29 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
         * (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
         */
+       /**
+        * <p>Getter for the field <code>entity</code>.</p>
+        *
+        * @return a ENTITY object.
+        */
        public ENTITY getEntity() {
                return entity;
        }
                
+       /**
+        * <p>getToggle</p>
+        *
+        * @return a {@link org.eclipse.ui.forms.widgets.ToggleHyperlink} object.
+        */
        public ToggleHyperlink getToggle(){
                return this.toggle;
        }
 
+       /**
+        * <p>getSection</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.forms.AbstractFormSection} object.
+        */
        public AbstractFormSection getSection(){
                return this;
        }       
@@ -124,6 +160,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent()
         */
+       /** {@inheritDoc} */
        public void firePropertyChangeEvent(CdmPropertyChangeEvent event) {
                Assert.isNotNull(propertyChangeListeners, "No property change listeners.");
                for(Object listener : propertyChangeListeners){
@@ -134,6 +171,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        /* (non-Javadoc)
         * @see org.eclipse.swt.widgets.Composite#setFocus()
         */
+       /** {@inheritDoc} */
        @Override
        public boolean setFocus() {
                return getClient().setFocus();
@@ -142,6 +180,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        /* (non-Javadoc)
         * @see org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
         */
+       /** {@inheritDoc} */
        public void propertyChange(PropertyChangeEvent event) {
                firePropertyChangeEvent(new CdmPropertyChangeEvent(this, event));
        }
@@ -149,6 +188,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        /* (non-Javadoc)
         * @see org.eclipse.swt.widgets.Control#setBackground(org.eclipse.swt.graphics.Color)
         */
+       /** {@inheritDoc} */
        @Override
        public void setBackground(Color color) {
                for(ICdmFormElement element : getElements()){
@@ -158,6 +198,11 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
                super.setBackground(color);
        }
        
+       /**
+        * <p>widgetSelected</p>
+        *
+        * @param e a {@link org.eclipse.swt.events.SelectionEvent} object.
+        */
        public void widgetSelected(SelectionEvent e) {
                Widget widget = e.widget;
                
@@ -187,9 +232,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
                }
        }
        
-       /**
-        * @param b
-        */
+       /** {@inheritDoc} */
        public void setSelected(boolean selected) {
                if(selected){
                        setBackground(Display.getCurrent().getSystemColor(SWT.COLOR_LIST_SELECTION));
@@ -199,6 +242,7 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        }
        
 
+       /** {@inheritDoc} */
        public void selectionChanged(SelectionChangedEvent event) {
                if(event.getSelection() == formFactory.EMPTY_SELECTION){
                        return;
@@ -215,33 +259,45 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        }
        
        /**
-        * 
-        * @param listener
+        * <p>addSelectionListener</p>
+        *
+        * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
         */
        public void addSelectionListener(SelectionListener listener) {
                addListener(SWT.Selection, new TypedListener(listener));
        }
         
        /**
-        * 
-        * @param listener
+        * <p>removeSelectionListener</p>
+        *
+        * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
         */
        public void removeSelectionListener(SelectionListener listener) {
                removeListener(SWT.Selection, listener);
        }
        
+       /** {@inheritDoc} */
        public Color getColor(boolean selected) {
                return selected ? SELECTED : NOT_SELECTED;
        }
        
+       /** {@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
@@ -274,14 +330,29 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
                elements.clear();
        }
        
+       /**
+        * <p>Getter for the field <code>parentElement</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        */
        public ICdmFormElement getParentElement() {
                return parentElement;
        }
        
+       /**
+        * <p>Getter for the field <code>elements</code>.</p>
+        *
+        * @return a {@link java.util.Set} object.
+        */
        public Set<ICdmFormElement> getElements() {
                return elements;
        }
        
+       /**
+        * <p>getControls</p>
+        *
+        * @return a {@link java.util.Set} object.
+        */
        public Set<Control> getControls() {
                Set<Control> controls = new HashSet<Control>();
                
@@ -292,16 +363,23 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
                return controls; 
        }
        
+       /** {@inheritDoc} */
        @Override
        public void dispose() {
                removeElements();
                super.dispose();
        }
        
+       /**
+        * <p>getLayoutComposite</p>
+        *
+        * @return a {@link org.eclipse.swt.widgets.Composite} object.
+        */
        public Composite getLayoutComposite() {
                return (Composite) getClient();
        }
        
+       /** {@inheritDoc} */
        public boolean containsFormElement(ICdmFormElement formElement){
                if(formElement == this){
                        return true;
@@ -317,6 +395,11 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
        }
 
 
+       /**
+        * <p>Getter for the field <code>formFactory</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        */
        public CdmFormFactory getFormFactory() {
                return formFactory;
        }
@@ -325,14 +408,23 @@ public abstract class AbstractFormSection<ENTITY> extends Section implements ISe
         * (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
         */
+       /**
+        * <p>refresh</p>
+        */
        public void refresh() {
                // empty default implementation
                
        }
        
+       /**
+        * <p>getConversationHolder</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        */
        public ConversationHolder getConversationHolder() {
                return conversation;
        }
        
+       /** {@inheritDoc} */
        public void update(CdmDataChangeMap changeEvents) {}
 }