java/java-impl/src/com/intellij/javadoc/GenerateJavadocDialog.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.javadoc;
  17
  18 import com.intellij.openapi.project.Project;
  19 import com.intellij.openapi.ui.DialogWrapper;
  20 import com.intellij.openapi.ui.Messages;
  21 import com.intellij.openapi.help.HelpManager;
  22 import com.intellij.ui.IdeBorderFactory;
  23 import com.intellij.CommonBundle;
  24
  25 import javax.swing.*;
  26 import java.awt.*;
  27 import java.awt.event.ActionEvent;
  28 import java.awt.event.ActionListener;
  29 import java.io.File;
  30
  31 final class GenerateJavadocDialog extends DialogWrapper {
  32   private JRadioButton myForProjectRadio;
  33   private JRadioButton myForPackageRadio;
  34   private JCheckBox myIncludeSubpackagesCheckBox;
  35   private final String myPackageName;
  36   private final JavadocConfigurable myConfigurable;
  37   private final Project myProject;
  38
  39   GenerateJavadocDialog(String packageName, Project project, JavadocConfiguration configuration) {
  40     super(project, true);
  41     myProject = project;
  42
  43     myConfigurable = configuration.createConfigurable();
  44
  45     setOKButtonText(JavadocBundle.message("javadoc.generate.start.button"));
  46     myPackageName = "".equals(packageName) ? JavadocBundle.message("javadoc.generate.package.default") : packageName;
  47     setTitle(JavadocBundle.message("javadoc.generate.title"));
  48     init();
  49     myConfigurable.reset();
  50   }
  51
  52   protected JComponent createNorthPanel() {
  53     JPanel panel = new JPanel(new GridBagLayout());
  54     panel.setBorder(BorderFactory.createEmptyBorder(4,8,8,0));
  55     GridBagConstraints gbConstraints = new GridBagConstraints();
  56     gbConstraints.gridy = 0;
  57     gbConstraints.gridx = 0;
  58     gbConstraints.gridwidth = 3;
  59     gbConstraints.gridheight = 1;
  60     gbConstraints.weightx = 1;
  61
  62     gbConstraints.fill = GridBagConstraints.BOTH;
  63     gbConstraints.insets = new Insets(0,0,0,0);
  64
  65     myForProjectRadio = new JRadioButton(JavadocBundle.message("javadoc.generate.scope.whole.project"));
  66     panel.add(myForProjectRadio, gbConstraints);
  67
  68     myForPackageRadio = new JRadioButton(
  69       JavadocBundle.message("javadoc.generate.scope.package", (myPackageName != null ? " \"" + myPackageName + "\"" : "")));
  70     gbConstraints.gridy++;
  71     gbConstraints.insets = new Insets(0,0,0,0);
  72     panel.add(myForPackageRadio, gbConstraints);
  73
  74     myIncludeSubpackagesCheckBox = new JCheckBox(JavadocBundle.message("javadoc.generate.scope.include.subpackages.checkbox"));
  75     gbConstraints.gridy++;
  76     gbConstraints.insets = new Insets(0,20,0,0);
  77     panel.add(myIncludeSubpackagesCheckBox, gbConstraints);
  78
  79
  80     ButtonGroup buttonGroup = new ButtonGroup();
  81     buttonGroup.add(myForProjectRadio);
  82     buttonGroup.add(myForPackageRadio);
  83
  84     ActionListener actionListener = new ActionListener() {
  85       public void actionPerformed(ActionEvent e) {
  86         myIncludeSubpackagesCheckBox.setEnabled(myForPackageRadio.isSelected());
  87       }
  88     };
  89
  90     myForProjectRadio.addActionListener(actionListener);
  91     myForPackageRadio.addActionListener(actionListener);
  92
  93     return panel;
  94   }
  95
  96   protected JComponent createCenterPanel() {
  97     JPanel pane = new JPanel(new BorderLayout());
  98     pane.setBorder(IdeBorderFactory.createTitledBorder(JavadocBundle.message("javadoc.generate.settings.group")));
  99     pane.add(myConfigurable.createComponent(), BorderLayout.CENTER);
 100     return pane;
 101   }
 102
 103   void reset() {
 104     myForPackageRadio.setEnabled(myPackageName != null);
 105     myForPackageRadio.setSelected(myPackageName != null);
 106     myForProjectRadio.setEnabled(true);
 107     myForProjectRadio.setSelected(myPackageName == null);
 108     myIncludeSubpackagesCheckBox.setSelected(myPackageName != null);
 109     myIncludeSubpackagesCheckBox.setEnabled(myPackageName != null && myForPackageRadio.isSelected());
 110   }
 111
 112   boolean isGenerationForProject() {
 113     return myForProjectRadio.isSelected();
 114   }
 115
 116   boolean isGenerationForPackage() {
 117     return myForPackageRadio.isSelected();
 118   }
 119
 120   boolean isGenerationWithSubpackages() {
 121     return isGenerationForPackage() && myIncludeSubpackagesCheckBox.isSelected();
 122   }
 123
 124   protected Action[] createActions(){
 125     return new Action[]{getOKAction(), getCancelAction(), getHelpAction() };
 126   }
 127
 128   protected void doOKAction() {
 129     if (checkOutputDirectory(myConfigurable.getOutputDir())) {
 130       myConfigurable.apply();
 131       close(OK_EXIT_CODE);
 132     }
 133   }
 134
 135   protected void doHelpAction() {
 136     HelpManager.getInstance().invokeHelp("editing.javadocGeneration");
 137   }
 138
 139   private boolean checkOutputDirectory(String outputDirectory) {
 140     if (outputDirectory == null || outputDirectory.trim().length() == 0) {
 141       Messages.showMessageDialog(myProject, JavadocBundle.message("javadoc.generate.output.directory.not.specified"),
 142                                  CommonBundle.getErrorTitle(), Messages.getErrorIcon());
 143       return false;
 144     }
 145
 146     File outputDir = new File(outputDirectory);
 147     if (!outputDir.exists()){
 148       int choice = Messages.showOkCancelDialog(
 149         myProject,
 150         JavadocBundle.message("javadoc.generate.output.directory.not.exists", outputDirectory),
 151         JavadocBundle.message("javadoc.generate.message.title"),
 152         Messages.getWarningIcon()
 153       );
 154       if (choice != 0) return false;
 155       if (!outputDir.mkdirs()){
 156         Messages.showMessageDialog(
 157           myProject,
 158           JavadocBundle.message("javadoc.generate.output.directory.creation.failed", outputDirectory),
 159           CommonBundle.getErrorTitle(),
 160           Messages.getErrorIcon()
 161         );
 162         return false;
 163       }
 164     }
 165     else if (!outputDir.isDirectory()){
 166       Messages.showMessageDialog(
 167         myProject,
 168         JavadocBundle.message("javadoc.generate.output.not.a.directory", outputDirectory),
 169         CommonBundle.getErrorTitle(),
 170         Messages.getErrorIcon()
 171       );
 172       return false;
 173     }
 174     return true;
 175   }
 176
 177 }