performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / section / supplemental / VersionElement.java
index f987ae8e6237c36a0dac0087b5247cf7bb43a196..0a6e2c5521e6139a014f832cb12c29a0913f881e 100644 (file)
@@ -23,6 +23,8 @@ import eu.etaxonomy.taxeditor.forms.IEntityElement;
 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
 
 /**
+ * <p>VersionElement class.</p>
+ *
  * @author n.hoffmann
  * @created Nov 5, 2009
  * @version 1.0
@@ -37,9 +39,12 @@ public class VersionElement extends AbstractCdmFormElement implements IEntityEle
        private VersionableEntity entity;
        
        /**
-        * @param parent
-        * @param listener
-        * @param style
+        * <p>Constructor for VersionElement.</p>
+        *
+        * @param style a int.
+        * @param toolkit a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
+        * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+        * @param entity a {@link eu.etaxonomy.cdm.model.common.VersionableEntity} object.
         */
        public VersionElement(CdmFormFactory toolkit, ICdmFormElement parentElement, VersionableEntity entity, int style) {
                super(toolkit, parentElement);
@@ -59,6 +64,11 @@ public class VersionElement extends AbstractCdmFormElement implements IEntityEle
                label_objectId.setLayoutData(CdmFormFactory.FILL_HORIZONTALLY());
        }
        
+       /**
+        * <p>Setter for the field <code>entity</code>.</p>
+        *
+        * @param entity a {@link eu.etaxonomy.cdm.model.common.VersionableEntity} object.
+        */
        public void setEntity(VersionableEntity entity){
 
                this.entity = entity;
@@ -105,10 +115,16 @@ public class VersionElement extends AbstractCdmFormElement implements IEntityEle
                return CdmUtils.Nz(user.getUsername());
        }
 
+       /**
+        * <p>Getter for the field <code>entity</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.model.common.VersionableEntity} object.
+        */
        public VersionableEntity getEntity() {
                return entity;
        }
 
+       /** {@inheritDoc} */
        public void setSelected(boolean selected) {
                // will not likely be selected
        }