performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-printpublisher / src / main / java / eu / etaxonomy / taxeditor / printpublisher / wizard / AbstractPublishWizard.java

diff --git a/taxeditor-printpublisher/src/main/java/eu/etaxonomy/taxeditor/printpublisher/wizard/AbstractPublishWizard.java b/taxeditor-printpublisher/src/main/java/eu/etaxonomy/taxeditor/printpublisher/wizard/AbstractPublishWizard.java
index 0143d6d1147e035258f8ce6170e0b91d63fa076d..1b50191f3e3442bb6c95ef20fd2ebf37ddba2663 100644 (file)
--- a/taxeditor-printpublisher/src/main/java/eu/etaxonomy/taxeditor/printpublisher/wizard/AbstractPublishWizard.java
+++ b/taxeditor-printpublisher/src/main/java/eu/etaxonomy/taxeditor/printpublisher/wizard/AbstractPublishWizard.java
@@ -20,18 +20,25 @@ import eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
 /**
- * 
+ * <p>AbstractPublishWizard class.</p>
+ *
  * @author n.hoffmann
  * @created Apr 1, 2010
  * @version 1.0
  */
 public class AbstractPublishWizard extends Wizard implements IExportWizard{
        
+       /** Constant <code>PAGE_SERVICE="PAGE_SERVICE"</code> */
        public static final String PAGE_SERVICE = "PAGE_SERVICE";
+       /** Constant <code>PAGE_TAXA="PAGE_TAXA"</code> */
        public static final String PAGE_TAXA = "PAGE_TAXA";
+       /** Constant <code>PAGE_OPTIONS="PAGE_OPTIONS"</code> */
        public static final String PAGE_OPTIONS = "PAGE_OPTIONS";
+       /** Constant <code>PAGE_FOLDER="PAGE_FOLDER"</code> */
        public static final String PAGE_FOLDER = "PAGE_FOLDER";
+       /** Constant <code>PAGE_OVERVIEW="PAGE_OVERVIEW"</code> */
        public static final String PAGE_OVERVIEW = "PAGE_OVERVIEW";
+       /** Constant <code>PAGE_FEATURETREE="PAGE_FEATURETREE"</code> */
        public static final String PAGE_FEATURETREE = "PAGE_FEATURETREE";
        
        protected SelectServiceWizardPage pageService;
@@ -45,6 +52,9 @@ public class AbstractPublishWizard extends Wizard implements IExportWizard{
 
        private IPublishOutputModule outputModule;
 
+       /**
+        * <p>Constructor for AbstractPublishWizard.</p>
+        */
        public AbstractPublishWizard(){         
                setNeedsProgressMonitor(true);
        }
@@ -52,6 +62,7 @@ public class AbstractPublishWizard extends Wizard implements IExportWizard{
        /* (non-Javadoc)
         * @see org.eclipse.jface.wizard.Wizard#performFinish()
         */
+       /** {@inheritDoc} */
        @Override
        public boolean performFinish() {
                
@@ -85,6 +96,7 @@ public class AbstractPublishWizard extends Wizard implements IExportWizard{
                return true;
        }
 
+       /** {@inheritDoc} */
        @Override
        public void addPages() {
                super.addPages();
@@ -111,12 +123,14 @@ public class AbstractPublishWizard extends Wizard implements IExportWizard{
        /* (non-Javadoc)
         * @see org.eclipse.ui.IWorkbenchWizard#init(org.eclipse.ui.IWorkbench, org.eclipse.jface.viewers.IStructuredSelection)
         */
+       /** {@inheritDoc} */
        public void init(IWorkbench workbench, IStructuredSelection selection) {
                PrintUtil.info("Instantiating wizard: " + this.getClass().getSimpleName());
        }
        
 
        
+       /** {@inheritDoc} */
        @Override
        public boolean canFinish() {
                return pageService.isPageComplete() && 
@@ -125,18 +139,38 @@ public class AbstractPublishWizard extends Wizard implements IExportWizard{
                                pageFolder.isPageComplete();
        }
        
+       /**
+        * <p>Getter for the field <code>configurator</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.print.PublishConfigurator} object.
+        */
        protected PublishConfigurator getConfigurator() {
                return configurator;
        }
        
+       /**
+        * <p>Setter for the field <code>configurator</code>.</p>
+        *
+        * @param configurator a {@link eu.etaxonomy.cdm.print.PublishConfigurator} object.
+        */
        protected void setConfigurator(PublishConfigurator configurator){
                this.configurator = configurator;
        }
        
+       /**
+        * <p>Setter for the field <code>outputModule</code>.</p>
+        *
+        * @param outputModule a {@link eu.etaxonomy.cdm.print.out.IPublishOutputModule} object.
+        */
        protected void setOutputModule(IPublishOutputModule outputModule){
                this.outputModule = outputModule;
        }
        
+       /**
+        * <p>Getter for the field <code>outputModule</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.print.out.IPublishOutputModule} object.
+        */
        public IPublishOutputModule getOutputModule(){
                return outputModule;
        }