c408b80ec8313cba11fe69588adcdc00dcc50b05
[idea/community.git] / plugins / maven / src / main / java / org / jetbrains / idea / maven / wizards / MavenArchetypesPanel.java
1 /*
2  * Copyright 2000-2013 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 org.jetbrains.idea.maven.wizards;
17
18 import com.intellij.ide.wizard.StepAdapter;
19 import com.intellij.openapi.Disposable;
20 import com.intellij.openapi.application.ApplicationManager;
21 import com.intellij.openapi.util.Disposer;
22 import com.intellij.openapi.util.text.StringUtil;
23 import com.intellij.ui.*;
24 import com.intellij.ui.treeStructure.Tree;
25 import com.intellij.util.containers.Convertor;
26 import com.intellij.util.ui.AsyncProcessIcon;
27 import com.intellij.util.ui.UIUtil;
28 import com.intellij.util.ui.tree.TreeUtil;
29 import org.jetbrains.annotations.Nullable;
30 import org.jetbrains.idea.maven.indices.MavenIndicesManager;
31 import org.jetbrains.idea.maven.model.MavenArchetype;
32
33 import javax.swing.*;
34 import javax.swing.event.TreeSelectionEvent;
35 import javax.swing.event.TreeSelectionListener;
36 import javax.swing.tree.*;
37 import java.awt.*;
38 import java.awt.event.ActionEvent;
39 import java.awt.event.ActionListener;
40 import java.util.*;
41 import java.util.List;
42
43 /**
44  * @author Dmitry Avdeev
45  *         Date: 24.09.13
46  */
47 public class MavenArchetypesPanel implements Disposable {
48
49   private JCheckBox myUseArchetypeCheckBox;
50   private JButton myAddArchetypeButton;
51   private JPanel myArchetypesPanel;
52   private final Tree myArchetypesTree;
53   private JScrollPane myArchetypeDescriptionScrollPane;
54   private JPanel myMainPanel;
55   private JTextArea myArchetypeDescriptionField;
56
57   private Object myCurrentUpdaterMarker;
58   private final AsyncProcessIcon myLoadingIcon = new AsyncProcessIcon.Big(getClass() + ".loading");
59
60   private boolean skipUpdateUI;
61   private final MavenModuleBuilder myBuilder;
62   @Nullable private final StepAdapter myStep;
63
64   public MavenArchetypesPanel(MavenModuleBuilder builder, @Nullable StepAdapter step) {
65     myBuilder = builder;
66     myStep = step;
67     Disposer.register(this, myLoadingIcon);
68
69     myArchetypesTree = new Tree();
70     myArchetypesTree.setModel(new DefaultTreeModel(new DefaultMutableTreeNode()));
71     JScrollPane archetypesScrollPane = ScrollPaneFactory.createScrollPane(myArchetypesTree);
72
73     myArchetypesPanel.add(archetypesScrollPane, "archetypes");
74
75     JPanel loadingPanel = new JPanel(new GridBagLayout());
76     JPanel bp = new JPanel(new BorderLayout(10, 10));
77     bp.add(new JLabel("Loading archetype list..."), BorderLayout.NORTH);
78     bp.add(myLoadingIcon, BorderLayout.CENTER);
79
80     loadingPanel.add(bp, new GridBagConstraints());
81
82     myArchetypesPanel.add(ScrollPaneFactory.createScrollPane(loadingPanel), "loading");
83     ((CardLayout)myArchetypesPanel.getLayout()).show(myArchetypesPanel, "archetypes");
84
85
86     myUseArchetypeCheckBox.addActionListener(new ActionListener() {
87       @Override
88       public void actionPerformed(ActionEvent e) {
89         updateComponents();
90       }
91     });
92     myUseArchetypeCheckBox.addActionListener(new ActionListener() {
93       @Override
94       public void actionPerformed(ActionEvent e) {
95         archetypeMayBeChanged();
96       }
97     });
98
99     myAddArchetypeButton.addActionListener(new ActionListener() {
100       public void actionPerformed(ActionEvent e) {
101         doAddArchetype();
102       }
103     });
104
105     myArchetypesTree.setRootVisible(false);
106     myArchetypesTree.setShowsRootHandles(true);
107     myArchetypesTree.setCellRenderer(new MyRenderer());
108     myArchetypesTree.getSelectionModel().setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
109
110     myArchetypesTree.getSelectionModel().addTreeSelectionListener(new TreeSelectionListener() {
111       public void valueChanged(TreeSelectionEvent e) {
112         updateArchetypeDescription();
113         archetypeMayBeChanged();
114       }
115     });
116
117     new TreeSpeedSearch(myArchetypesTree, new Convertor<TreePath, String>() {
118       public String convert(TreePath path) {
119         MavenArchetype info = getArchetypeInfoFromPathComponent(path.getLastPathComponent());
120         return info.groupId + ":" + info.artifactId + ":" + info.version;
121       }
122     }).setComparator(new SpeedSearchComparator(false));
123
124     myArchetypeDescriptionField.setEditable(false);
125     myArchetypeDescriptionField.setBackground(UIUtil.getPanelBackground());
126
127     requestUpdate();
128     updateComponents();
129   }
130
131   public JPanel getMainPanel() {
132     return myMainPanel;
133   }
134
135   private void updateComponents() {
136     boolean archetypesEnabled = myUseArchetypeCheckBox.isSelected();
137     myAddArchetypeButton.setEnabled(archetypesEnabled);
138     myArchetypesTree.setEnabled(archetypesEnabled);
139     myArchetypesTree.setBackground(archetypesEnabled ? UIUtil.getListBackground() : UIUtil.getPanelBackground());
140
141   }
142
143   @Nullable
144   public MavenArchetype getSelectedArchetype() {
145     if (!myUseArchetypeCheckBox.isSelected() || myArchetypesTree.isSelectionEmpty()) return null;
146     return getArchetypeInfoFromPathComponent(myArchetypesTree.getLastSelectedPathComponent());
147   }
148
149   private static MavenArchetype getArchetypeInfoFromPathComponent(Object sel) {
150     return (MavenArchetype)((DefaultMutableTreeNode)sel).getUserObject();
151   }
152
153   private void updateArchetypeDescription() {
154     MavenArchetype sel = getSelectedArchetype();
155     String desc = sel == null ? null : sel.description;
156     if (StringUtil.isEmptyOrSpaces(desc)) {
157       myArchetypeDescriptionScrollPane.setVisible(false);
158     }
159     else {
160       myArchetypeDescriptionScrollPane.setVisible(true);
161       myArchetypeDescriptionField.setText(desc);
162     }
163   }
164
165   @Nullable
166   private static TreePath findNodePath(MavenArchetype object, TreeModel model, Object parent) {
167     for (int i = 0; i < model.getChildCount(parent); i++) {
168       DefaultMutableTreeNode each = (DefaultMutableTreeNode)model.getChild(parent, i);
169       if (each.getUserObject().equals(object)) return new TreePath(each.getPath());
170
171       TreePath result = findNodePath(object, model, each);
172       if (result != null) return result;
173     }
174     return null;
175   }
176
177   private static TreeNode groupAndSortArchetypes(Set<MavenArchetype> archetypes) {
178     List<MavenArchetype> list = new ArrayList<MavenArchetype>(archetypes);
179
180     Collections.sort(list, new Comparator<MavenArchetype>() {
181       public int compare(MavenArchetype o1, MavenArchetype o2) {
182         String key1 = o1.groupId + ":" + o1.artifactId;
183         String key2 = o2.groupId + ":" + o2.artifactId;
184
185         int result = key1.compareToIgnoreCase(key2);
186         if (result != 0) return result;
187
188         return o2.version.compareToIgnoreCase(o1.version);
189       }
190     });
191
192     Map<String, List<MavenArchetype>> map = new TreeMap<String, List<MavenArchetype>>();
193
194     for (MavenArchetype each : list) {
195       String key = each.groupId + ":" + each.artifactId;
196       List<MavenArchetype> versions = map.get(key);
197       if (versions == null) {
198         versions = new ArrayList<MavenArchetype>();
199         map.put(key, versions);
200       }
201       versions.add(each);
202     }
203
204     DefaultMutableTreeNode result = new DefaultMutableTreeNode("root", true);
205     for (List<MavenArchetype> each : map.values()) {
206       MavenArchetype eachArchetype = each.get(0);
207       DefaultMutableTreeNode node = new DefaultMutableTreeNode(eachArchetype, true);
208       for (MavenArchetype eachVersion : each) {
209         DefaultMutableTreeNode versionNode = new DefaultMutableTreeNode(eachVersion, false);
210         node.add(versionNode);
211       }
212       result.add(node);
213     }
214
215     return result;
216   }
217
218   public void requestUpdate() {
219
220     MavenArchetype selectedArch = getSelectedArchetype();
221     if (selectedArch == null) {
222       selectedArch = myBuilder.getArchetype();
223     }
224     if (selectedArch != null) myUseArchetypeCheckBox.setSelected(true);
225
226     if (myArchetypesTree.getRowCount() == 0) updateArchetypesList(selectedArch);
227   }
228
229   public void updateArchetypesList(final MavenArchetype selected) {
230     ApplicationManager.getApplication().assertIsDispatchThread();
231
232     myLoadingIcon.setBackground(myArchetypesTree.getBackground());
233
234     ((CardLayout)myArchetypesPanel.getLayout()).show(myArchetypesPanel, "loading");
235
236     final Object currentUpdaterMarker = new Object();
237     myCurrentUpdaterMarker = currentUpdaterMarker;
238
239     ApplicationManager.getApplication().executeOnPooledThread(new Runnable() {
240       public void run() {
241         final Set<MavenArchetype> archetypes = MavenIndicesManager.getInstance().getArchetypes();
242
243         //noinspection SSBasedInspection
244         SwingUtilities.invokeLater(new Runnable() {
245           public void run() {
246             if (currentUpdaterMarker != myCurrentUpdaterMarker) return; // Other updater has been run.
247
248             ((CardLayout)myArchetypesPanel.getLayout()).show(myArchetypesPanel, "archetypes");
249
250             TreeNode root = groupAndSortArchetypes(archetypes);
251             TreeModel model = new DefaultTreeModel(root);
252             myArchetypesTree.setModel(model);
253
254             if (selected != null) {
255               TreePath path = findNodePath(selected, model, model.getRoot());
256               if (path != null) {
257                 myArchetypesTree.expandPath(path.getParentPath());
258                 TreeUtil.selectPath(myArchetypesTree, path, true);
259               }
260             }
261
262             updateArchetypeDescription();
263           }
264         });
265       }
266     });
267   }
268
269   private void archetypeMayBeChanged() {
270     MavenArchetype selectedArchetype = getSelectedArchetype();
271     if (((myBuilder.getArchetype() == null) != (selectedArchetype == null))) {
272       myBuilder.setArchetype(selectedArchetype);
273       skipUpdateUI = true;
274       try {
275         if (myStep != null) {
276           myStep.fireStateChanged();
277         }
278       }
279       finally {
280         skipUpdateUI = false;
281       }
282     }
283   }
284
285
286   private void doAddArchetype() {
287     MavenAddArchetypeDialog dialog = new MavenAddArchetypeDialog(myMainPanel);
288     dialog.show();
289     if (!dialog.isOK()) return;
290
291     MavenArchetype archetype = dialog.getArchetype();
292     MavenIndicesManager.getInstance().addArchetype(archetype);
293     updateArchetypesList(archetype);
294   }
295
296   @Override
297   public void dispose() {
298   }
299
300   private static class MyRenderer extends ColoredTreeCellRenderer {
301     public void customizeCellRenderer(JTree tree,
302                                       Object value,
303                                       boolean selected,
304                                       boolean expanded,
305                                       boolean leaf,
306                                       int row,
307                                       boolean hasFocus) {
308       Object userObject = ((DefaultMutableTreeNode)value).getUserObject();
309       if (!(userObject instanceof MavenArchetype)) return;
310
311       MavenArchetype info = (MavenArchetype)userObject;
312
313       if (leaf) {
314         append(info.artifactId, SimpleTextAttributes.GRAY_ATTRIBUTES);
315         append(":" + info.version, SimpleTextAttributes.REGULAR_ATTRIBUTES);
316       }
317       else {
318         append(info.groupId + ":", SimpleTextAttributes.GRAY_ATTRIBUTES);
319         append(info.artifactId, SimpleTextAttributes.REGULAR_ATTRIBUTES);
320       }
321     }
322   }
323
324 }