org.netbeans.modules.maven.nodes.MavenProjectNode Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.maven.nodes;
import java.awt.Image;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.CharConversionException;
import java.util.Collection;
import java.util.StringTokenizer;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.SwingUtilities;
import org.apache.maven.project.MavenProject;
import org.netbeans.api.project.ProjectInformation;
import org.netbeans.api.project.ProjectUtils;
import org.netbeans.modules.maven.NbMavenProjectImpl;
import org.netbeans.modules.maven.api.NbMavenProject;
import static org.netbeans.modules.maven.nodes.Bundle.*;
import org.netbeans.modules.maven.spi.IconResources;
import org.netbeans.modules.maven.spi.nodes.SpecialIcon;
import org.netbeans.spi.project.ui.ProjectProblemsProvider;
import org.netbeans.spi.project.ui.ProjectProblemsProvider.ProjectProblem;
import org.netbeans.spi.project.ui.support.CommonProjectActions;
import org.netbeans.spi.project.ui.support.NodeFactorySupport;
import org.openide.filesystems.FileUtil;
import org.openide.nodes.AbstractNode;
import org.openide.util.ImageUtilities;
import org.openide.util.Lookup;
import org.openide.util.NbBundle.Messages;
import org.openide.xml.XMLUtil;
/** A node to represent project root.
*
* @author Milos Kleint
*/
public class MavenProjectNode extends AbstractNode {
private static final Logger LOGGER = Logger.getLogger(MavenProjectNode.class.getName());
@Messages("ICON_BrokenProjectBadge=Project loading failed or was not complete")
private static final String toolTipBroken = "![](\"")
" + ICON_BrokenProjectBadge();
private final NbMavenProjectImpl project;
private final ProjectInformation info;
public MavenProjectNode(Lookup lookup, NbMavenProjectImpl proj) {
super(NodeFactorySupport.createCompositeChildren(proj, "Projects/org-netbeans-modules-maven/Nodes"), lookup); //NOI18N
this.project = proj;
info = ProjectUtils.getInformation(project);
info.addPropertyChangeListener(new PropertyChangeListener() {
@Override public void propertyChange(PropertyChangeEvent event) {
String prop = event.getPropertyName();
if (ProjectInformation.PROP_NAME.equals(prop)) {
fireNameChange(null, null);
} else if (ProjectInformation.PROP_DISPLAY_NAME.equals(prop)) {
fireDisplayNameChange(null, getDisplayName());
} else if (ProjectInformation.PROP_ICON.equals(prop)) {
fireIconChange();
fireOpenedIconChange();
}
}
});
proj.getLookup().lookup(ProjectProblemsProvider.class).addPropertyChangeListener(new PropertyChangeListener() {
@Override
public void propertyChange(PropertyChangeEvent evt) {
if (ProjectProblemsProvider.PROP_PROBLEMS.equals(evt.getPropertyName())) {
SwingUtilities.invokeLater(new Runnable() {
@Override
public void run() {
fireNameChange(null, getName());
fireDisplayNameChange(null, getDisplayName());
fireShortDescriptionChange(null, getShortDescription());
}
});
}
}
});
}
public @Override String getName() {
return project.getProjectDirectory().toURI().toString();
}
@Override
public String getDisplayName() {
return info.getDisplayName();
}
public @Override String getHtmlDisplayName() {
if (!project.isMavenProjectLoaded()) {
return null;
}
String packaging = project.getOriginalMavenProject().getPackaging();
if (project.getLookup().lookup(SpecialIcon.class) != null) {
return null;
}
try {
return XMLUtil.toElementContent(getDisplayName()) + " " + packaging + "";
} catch (CharConversionException x) {
return null;
}
}
@Override
public Image getIcon(int param) {
Icon icon = info.getIcon();
if (icon == null) {
LOGGER.log(Level.WARNING, "no icon in {0}", info);
return super.getIcon(param);
}
return ImageUtilities.icon2Image(icon);
}
@Override
public Image getOpenedIcon(int param) {
return getIcon(param);
}
public @Override Action[] getActions(boolean param) {
return CommonProjectActions.forType("org-netbeans-modules-maven"); // NOI18N
}
@Messages({
"TXT_FailedProjectLoadingDesc=This project could not be loaded by the NetBeans Connector. "
+ "That usually means something is wrong with your pom.xml, or plugins are missing. "
+ "Select \"Show and Resolve Problems\" from the project's context menu for additional information.",
"LBL_DefaultDescription=A Maven-based project",
"TXT_Loading=Loading...",
"DESC_Project1=Location:",
"DESC_Project2=GroupId:",
"DESC_Project3=ArtifactId:",
"DESC_Project4=Version:",
"DESC_Project5=Packaging:",
"DESC_Project6=Description:",
"DESC_Project7=Problems:"
})
@Override public String getShortDescription() {
StringBuilder buf = new StringBuilder();
String desc;
MavenProject mp = project.isMavenProjectLoaded() ? project.getOriginalMavenProject() : null;
if(mp != null) {
if (NbMavenProject.isErrorPlaceholder(mp)) {
desc = TXT_FailedProjectLoadingDesc();
} else {
//TODO escape the short description
desc = mp.getDescription();
if (desc == null) {
desc = LBL_DefaultDescription();
}
}
} else {
desc = TXT_Loading();
}
buf.append("").append(DESC_Project1()).append(" ").append(FileUtil.getFileDisplayName(project.getProjectDirectory())).append("
"); //NOI18N
if (mp != null) {
buf.append(DESC_Project2()).append(" ").append(mp.getGroupId()).append("
");//NOI18N
buf.append(DESC_Project3()).append(" ").append(mp.getArtifactId()).append("
");//NOI18N
buf.append(DESC_Project4()).append(" ").append(mp.getVersion()).append("
");//NOI18N
buf.append(DESC_Project5()).append(" ").append(mp.getPackaging()).append("
");//NOI18N
}
buf.append(DESC_Project6()).append(" ").append(breakPerLine(desc, DESC_Project5().length()));//NOI18N
Collection problems = project.getLookup().lookup(ProjectProblemsProvider.class).getProblems();
if (!problems.isEmpty()) {
buf.append("
").append(DESC_Project7()).append("
");//NOI18N
for (ProjectProblem elem : problems) {
buf.append("- ").append(elem.getDisplayName()).append("
");//NOI18N
}
buf.append("
");//NOI18N
}
// it seems that with ending tag the icon descriptions are not added.
// buf.append("