performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / forms / TimePeriodElement.java
index b1ae1bc4a1501997eccab993f9a52a52e30c8afc..1a7109338d86a9114fc368a8d9c834f00e597fae 100644 (file)
@@ -18,6 +18,8 @@ import org.eclipse.ui.forms.widgets.Section;
 import eu.etaxonomy.cdm.model.common.TimePeriod;
 
 /**
+ * <p>TimePeriodElement class.</p>
+ *
  * @author n.hoffmann
  * @created Nov 17, 2009
  * @version 1.0
@@ -30,9 +32,13 @@ public class TimePeriodElement extends AbstractCdmFormElementWithErrors{
        private Label emptyLabel;
        
        /**
-        * @param parent
-        * @param listener
-        * @param style
+        * <p>Constructor for TimePeriodElement.</p>
+        *
+        * @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.
+        * @param timePeriod a {@link eu.etaxonomy.cdm.model.common.TimePeriod} object.
         */
        public TimePeriodElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString, TimePeriod timePeriod, final int style) {
                super(formFactory, parentElement);
@@ -50,14 +56,21 @@ public class TimePeriodElement extends AbstractCdmFormElementWithErrors{
                
        }
 
+       /** {@inheritDoc} */
        public void setSelected(boolean selected) {
                setBackground(getColor(selected));
        }
 
+       /**
+        * <p>setEntity</p>
+        *
+        * @param timePeriod a {@link eu.etaxonomy.cdm.model.common.TimePeriod} object.
+        */
        public void setEntity(TimePeriod timePeriod) {
                setTimePeriod(timePeriod);
        }
        
+       /** {@inheritDoc} */
        @Override
        public void propertyChange(PropertyChangeEvent event) {
                if(event == null){
@@ -99,6 +112,8 @@ public class TimePeriodElement extends AbstractCdmFormElementWithErrors{
        }
 
        /**
+        * <p>Setter for the field <code>timePeriod</code>.</p>
+        *
         * @param timePeriod the timePeriod to set
         */
        public void setTimePeriod(TimePeriod timePeriod) {
@@ -110,12 +125,15 @@ public class TimePeriodElement extends AbstractCdmFormElementWithErrors{
        }
 
        /**
+        * <p>Getter for the field <code>timePeriod</code>.</p>
+        *
         * @return the timePeriod
         */
        public TimePeriod getTimePeriod() {
                return timePeriod;
        }
        
+       /** {@inheritDoc} */
        @Override
        public void setBackground(Color color) {
                emptyLabel.setBackground(color);