performed javacscript:fix and worked on documentation

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

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/CheckboxElement.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/CheckboxElement.java
index bbc65b99038e17b5afd631d790144d66b35b2f80..c55114b4d1781f9e7625bc6a021ce1b4ac1e8f94 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/CheckboxElement.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/CheckboxElement.java
@@ -21,6 +21,8 @@ import eu.etaxonomy.taxeditor.editor.EditorUtil;
 import eu.etaxonomy.taxeditor.preference.Resources;
 
 /**
+ * <p>CheckboxElement class.</p>
+ *
  * @author n.hoffmann
  * @created Nov 5, 2009
  * @version 1.0
@@ -32,12 +34,13 @@ public class CheckboxElement extends AbstractCdmFormElement implements Selection
        private Label label;
        
        /**
-        * 
-        * @param parent
-        * @param label
-        * @param initialState
-        * @param listener
-        * @param style
+        * <p>Constructor for CheckboxElement.</p>
+        *
+        * @param initialState a boolean.
+        * @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 labelString a {@link java.lang.String} object.
         */
        protected CheckboxElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString, boolean initialState,
                        int style) {
@@ -57,12 +60,22 @@ public class CheckboxElement extends AbstractCdmFormElement implements Selection
                addControl(checkbox);
        }
 
+       /**
+        * <p>setSelection</p>
+        *
+        * @param selected a boolean.
+        */
        public void setSelection(boolean selected){
                checkbox.removeSelectionListener(this);
                checkbox.setSelection(selected);
                checkbox.addSelectionListener(this);
        }
        
+       /**
+        * <p>getSelection</p>
+        *
+        * @return a boolean.
+        */
        public boolean getSelection(){
                return checkbox.getSelection();
        }
@@ -70,20 +83,25 @@ public class CheckboxElement extends AbstractCdmFormElement implements Selection
        /* (non-Javadoc)
         * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
         */
+       /** {@inheritDoc} */
        public void widgetSelected(SelectionEvent e) {
                firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
        }
        
+       /** {@inheritDoc} */
        public void widgetDefaultSelected(SelectionEvent e) {}
 
+       /** {@inheritDoc} */
        public void setSelected(boolean selected) {
                checkbox.setBackground(getColor(selected));
        }
 
+       /** {@inheritDoc} */
        public void setEnabled(boolean enabled) {
                checkbox.setEnabled(enabled);
        }
 
+       /** {@inheritDoc} */
        public void setIrrelevant(boolean irrelevant) {
                String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT : Resources.COLOR_COMPOSITE_BACKGROUND;
                
@@ -94,6 +112,7 @@ public class CheckboxElement extends AbstractCdmFormElement implements Selection
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.AbstractCdmFormElement#setBackground(org.eclipse.swt.graphics.Color)
         */
+       /** {@inheritDoc} */
        @Override
        public void setBackground(Color color) {
                checkbox.setBackground(color);