<change id="ProjectIconAnnotator">

            <api name="general"/>

            <summary>Added <code>ProjectIconAnnotator</code></summary>

            <version major="1" minor="33"/>

            <date day="22" month="6" year="2010"/>

            <author login="jbecicka"/>

            <compatibility addition="yes" />

            <description>

                <p>

                    A mechanism for changing the project node icon.

                    You can use it for example to add a badge to the project's icon.

                </p>

            </description>

            <class package="org.netbeans.spi.project" name="ProjectIconAnnotator"/>

            <issue number="171516"/>

        </change>

import java.beans.PropertyChangeEvent;

import javax.swing.event.ChangeEvent;

import org.netbeans.spi.project.ProjectIconAnnotator;

import java.awt.Image;

import java.beans.PropertyChangeSupport;

import javax.swing.event.ChangeListener;

import org.openide.util.Lookup;

import org.openide.util.Lookup.Result;

import org.openide.util.LookupEvent;

import org.openide.util.LookupListener;

import org.openide.util.WeakListeners;

import org.openide.util.WeakSet;

        ProjectInformation retVal = new AnnotateIconProxyProjectInformation(p, pi);

        return retVal;

    private static final class AnnotateIconProxyProjectInformation implements ProjectInformation {

        private final ProjectInformation pinfo;

        private Icon icon;

        private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);

        private final Set<ProjectIconAnnotator> pias = new WeakSet<ProjectIconAnnotator>();

        private final PropertyChangeListener listener = new PropertyChangeListener(){

            @Override

            public void propertyChange(PropertyChangeEvent evt) {

                if (pinfo.PROP_ICON.equals(evt.getPropertyName())) {

                    updateIcon(pinfo, getProject());

                }

                pcs.firePropertyChange(evt.getPropertyName(), evt.getOldValue(), evt.getNewValue());

            }

        };

        private final ChangeListener clistener = new ChangeListener() {

            @Override

            public void stateChanged(ChangeEvent e) {

                updateIcon(pinfo, getProject());

                pcs.firePropertyChange(pinfo.PROP_ICON, null, getIcon());

            }

        };

        public AnnotateIconProxyProjectInformation(Project p, ProjectInformation pi) {

            this.pinfo = pi;

            this.pinfo.addPropertyChangeListener(WeakListeners.propertyChange(listener, pinfo));

            final Result<ProjectIconAnnotator> lookupResult = Lookup.getDefault().lookupResult(ProjectIconAnnotator.class);

            lookupResult.addLookupListener(new LookupListener() {

                @Override

                public void resultChanged(LookupEvent ev) {

                    updateIcon(pinfo, getProject());

                    initIconAnnotations(lookupResult);

                    pcs.firePropertyChange(pinfo.PROP_ICON, null, getIcon());

                }

            });

            initIconAnnotations(lookupResult);

            updateIcon(pi, p);

        }

        private void initIconAnnotations(Result<ProjectIconAnnotator> lookupResult) {

            for (ProjectIconAnnotator pa : lookupResult.allInstances()) {

                if (!pias.contains(pa)) {

                    pa.addChangeListener(WeakListeners.change(clistener, pa));

                    pias.add(pa);

                }

            }

        }

        private void updateIcon(ProjectInformation pi, Project p) {

            Image _icon = ImageUtilities.icon2Image(pi.getIcon());

            for (ProjectIconAnnotator pa : Lookup.getDefault().lookupAll(ProjectIconAnnotator.class)) {

                _icon = pa.annotateIcon(p, _icon, false);

            }

            icon = ImageUtilities.image2Icon(_icon);

        }

        @Override

        public String getName() {

            return pinfo.getName();

        }

        @Override

        public String getDisplayName() {

            return pinfo.getDisplayName();

        }

        @Override

        public Icon getIcon() {

            return icon;

        }

        @Override

        public Project getProject() {

            return pinfo.getProject();

        }

        @Override

        public synchronized void addPropertyChangeListener(PropertyChangeListener listener) {

            pcs.addPropertyChangeListener(listener);

        }

        @Override

        public synchronized void removePropertyChangeListener(PropertyChangeListener listener) {

            pcs.removePropertyChangeListener(listener);

        }

    }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.spi.project;

import java.awt.Image;

import javax.swing.event.ChangeListener;

import org.netbeans.api.project.Project;

/**

 * <p>The interface provides a mechanism for changing the project node icon.

 * You can use it for example to add a badge to the project's icon. Class implementing this

 * interface should be registered using {@link org.openide.util.lookup.ServiceProvider}.</p>

 * <pre>

 * @ServiceProvider(service=ProjectIconAnnotator.class)

 * public class SampleProjectIconAnnotator implements ProjectIconAnnotator {

 *

 *   private static final Image badgeOpened = ImageUtilities.loadImage("org/samplepath/opened-badge.png");

 *   private static final Image badgeClosed = ImageUtilities.loadImage("org/samplepath/closed-badge.png");

 *   private static final String tooltip = "Sample tooltip."

 *   private ChangeSupport pcs = new ChangeSupport(this);

 *

 *   Image annotateIcon(Project p, Image original, boolean openedNode) {

 *       original = ImageUtilities.addToolTipToImage(original, tooltip);

 *       if (openedNode) {

 *           original = ImageUtilities.mergeImages(original, badgeOpened, 16, 0);

 *       } else {

 *           original = ImageUtilities.mergeImages(original, badgeClosed, 16, 0);

 *       }

 *       return original;

 *   }

 *

 *    @Override

 *    public void addChangeListener(ChangeListener listener) {

 *        pcs.addChangeListener(listener);

 *    }

 *

 *    @Override

 *    public void removeChangeListener(ChangeListener listener) {

 *        pcs.removeChangeListener(listener);

 *    }

 *

 *    public void updateMyBadges() {

 *        pcs.fireChange();

 *    }

 *

 * }

 * </pre>

 * @author petrdvorak

 * @since 1.33

 */

public interface ProjectIconAnnotator {

    /**

     * Returns image representing annotated project icon. Return {@code original} if you do not

     * intend to change the original icon.

     * @param p Project whose icon is to be annotated

     * @param original Image with the original icon

     * @param openedNode Flag indicating if the node that uses the icon is in opened state or not

     * @return Annotated project icon

     */

    public Image annotateIcon(Project p, Image original, boolean openedNode);

    /**

     * Add a listener to property changes.

     * Only {@link #PROP_ICON} may be fired.

     * old and new values are undefined

     * @param listener a listener to add

     */

    public void addChangeListener(ChangeListener listener);

    /**

     * Remove a listener to property changes.

     * @param listener a listener to remove

     */

    public void removeChangeListener(ChangeListener listener);

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.api.project;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.io.IOException;

import org.netbeans.spi.project.ProjectIconAnnotator;

import java.awt.Image;

import javax.swing.Icon;

import javax.swing.event.ChangeListener;

import org.netbeans.junit.NbTestCase;

import org.openide.filesystems.FileObject;

import org.openide.util.ChangeSupport;

import org.openide.util.ImageUtilities;

import org.openide.util.test.MockLookup;

/**

 *

 * @author petrdvorak

 */

public class ProjectIconAnnotatorTest extends NbTestCase {

    public ProjectIconAnnotatorTest(String name) {

        super(name);

    }

    final static Image icon1 = ImageUtilities.loadImage("org/netbeans/api/project/resources/icon-1.png");

    private FileObject scratch;

    private FileObject goodproject;

    private ProjectManager pm;

    private ProjectIconAnnotatorImpl pia;

    private String testEventName;

    @Override

    protected void setUp() throws Exception {

        super.setUp();

        scratch = TestUtil.makeScratchDir(this);

        goodproject = scratch.createFolder("good");

        goodproject.createFolder("testproject");

        MockLookup.setInstances(TestUtil.testProjectFactory(), pia = new ProjectIconAnnotatorImpl());

        pm = ProjectManager.getDefault();

        pm.reset();

    }

    @Override

    protected void tearDown() throws Exception {

        scratch = null;

        goodproject = null;

        pm = null;

        testEventName = null;

        pia = null;

        super.tearDown();

    }

    /**

     * Test of annotateIcon method, of class ProjectIconAnnotator.

     */

    public void testAnnotateIcon() throws IOException {

        Project p = pm.findProject(goodproject);

        ProjectInformation pi = ProjectUtils.getInformation(p);

        Icon img = pi.getIcon();

        assertEquals("Annotated image height should be 8", img.getIconHeight(), 8);

        assertEquals("Annotated image width should be 8", img.getIconWidth(), 8);

        pi.addPropertyChangeListener(new PropertyChangeListener() {

            @Override

            public void propertyChange(PropertyChangeEvent evt) {

                testEventName=evt.getPropertyName();

            }

        });

        pia.updateBadges();

        assertEquals("Event not fired properly", pi.PROP_ICON, testEventName);

    }

    public static final class ProjectIconAnnotatorImpl implements ProjectIconAnnotator {

        private ChangeSupport pcs = new ChangeSupport(this);

        public ProjectIconAnnotatorImpl() {

        }

        @Override

        public Image annotateIcon(Project p, Image original, boolean openedNode) {

            return icon1;

        }

        @Override

        public void addChangeListener(ChangeListener listener) {

            pcs.addChangeListener(listener);

        }

        @Override

        public void removeChangeListener(ChangeListener listener) {

            pcs.removeChangeListener(listener);

        }

        public void updateBadges() {

            pcs.fireChange();

        }

    }

}

import org.netbeans.spi.project.ProjectIconAnnotator;

                Project p = getLookup().lookup(Project.class);

                if (p != null) {

                    for (ProjectIconAnnotator pa : Lookup.getDefault().lookupAll(ProjectIconAnnotator.class)) {

                        img = pa.annotateIcon(p, img, false);

            }

                }

                Project p = getLookup().lookup(Project.class);

                if (p != null) {

                    for (ProjectIconAnnotator pa : Lookup.getDefault().lookupAll(ProjectIconAnnotator.class)) {

                        img = pa.annotateIcon(p, img, true);

                    }

                }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.project.ui;

import java.awt.Graphics;

import java.awt.Image;

import java.awt.image.ImageObserver;

import java.awt.image.ImageProducer;

import java.beans.BeanInfo;

import java.io.IOException;

import java.util.Arrays;

import java.util.Collection;

import java.util.HashSet;

import java.util.Set;

import java.util.TreeSet;

import javax.swing.event.ChangeListener;

import org.netbeans.api.project.Project;

import org.netbeans.spi.project.ProjectIconAnnotator;

import org.netbeans.junit.MockServices;

import org.netbeans.junit.NbTestCase;

import org.netbeans.modules.project.ui.actions.TestSupport.TestProject;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileStatusEvent;

import org.openide.filesystems.FileSystem;

import org.openide.filesystems.FileSystem.HtmlStatus;

import org.openide.filesystems.FileUtil;

import org.openide.filesystems.MultiFileSystem;

import org.openide.nodes.AbstractNode;

import org.openide.nodes.Children;

import org.openide.util.ImageUtilities;

import org.openide.util.Lookup;

import org.openide.util.lookup.Lookups;

/**

 *

 * @author petrdvorak

 */

public class ProjectRootNodeIconTest extends NbTestCase {

    public ProjectRootNodeIconTest(String name) {

        super(name);

    }

    final static Image icon1 = ImageUtilities.loadImage("org/netbeans/modules/project/ui/resources/icon-1.png");

    final static Image icon2 = ImageUtilities.loadImage("org/netbeans/modules/project/ui/resources/icon-2.png");

    final static Image icon3 = ImageUtilities.loadImage("org/netbeans/modules/project/ui/resources/icon-3.png");

    public void testIconAnnotated() throws IOException, Exception {

        class BadgedImage extends Image {

            final Image original;

            BadgedImage(Image original) {this.original = original;}

            public @Override int getWidth(ImageObserver observer) {return original.getWidth(observer);}

            public @Override int getHeight(ImageObserver observer) {return original.getHeight(observer);}

            public @Override ImageProducer getSource() {return original.getSource();}

            public @Override Graphics getGraphics() {return original.getGraphics();}

            public @Override Object getProperty(String name, ImageObserver observer) {return original.getProperty(name, observer);}

            public @Override void flush() {original.flush();}

        }

        class TestFS extends MultiFileSystem {

            String nameBadge = "";

            String htmlBadge = "";

            boolean badging;

            Set<? extends FileObject> badgedFiles;

            TestFS() throws Exception {

                super(new FileSystem[] {FileUtil.createMemoryFileSystem()});

            }

            public @Override Status getStatus() {

                return new HtmlStatus() {

                    public String annotateName(String name, Set<? extends FileObject> files) {

                        badgedFiles = files;

                        return name + nameBadge;

                    }

                    public String annotateNameHtml(String name, Set<? extends FileObject> files) {

                        badgedFiles = files;

                        return name + htmlBadge;

                    }

                    public Image annotateIcon(Image icon, int iconType, Set<? extends FileObject> files) {

                        badgedFiles = files;

                        return badging ? new BadgedImage(icon) : icon;

                    }

                };

            }

            void fireChange(boolean icon, boolean name, FileObject... files) {

                fireFileStatusChanged(new FileStatusEvent(this, new HashSet<FileObject>(Arrays.asList(files)), icon, name));

            }

        }

        TestFS fs = new TestFS();

        FileObject root = fs.getRoot();

        Project prj = new TestProject(root, null);

        assertNotNull(prj);

        MockServices.setServices(ProjectIconAnnotatorImpl.class);

        Collection<? extends ProjectIconAnnotator> lookupAll = Lookup.getDefault().lookupAll(ProjectIconAnnotator.class);

        System.setProperty("test.nodelay", "true");

        ProjectsRootNode.BadgingNode node = new ProjectsRootNode.BadgingNode(null, new ProjectsRootNode.ProjectChildren.Pair(prj),

                new AbstractNode(Children.LEAF, Lookups.singleton(prj)) {

                    public @Override String getDisplayName() {return "Prj";}

                    public @Override String getHtmlDisplayName() {return "Prj";}

                }, false, true);

        Set<FileObject> fos = new TreeSet<FileObject>();

        fos.add(prj.getProjectDirectory());

        node.setFiles(fos);

        Image img = node.getIcon(BeanInfo.ICON_COLOR_16x16);

        assertTrue("Icon is not the same as 'icon3'", img.equals(icon3));

        assertFalse("Icon is the same as 'icon2'", img.equals(icon2));

        img = node.getOpenedIcon(BeanInfo.ICON_COLOR_16x16);

        assertTrue("Icon is not the same as 'icon2'", img.equals(icon2));

        assertFalse("Icon is the same as 'icon3'", img.equals(icon3));

    }

    public static final class ProjectIconAnnotatorImpl implements ProjectIconAnnotator {

        public ProjectIconAnnotatorImpl() {

        }

        public Image annotateIcon(Project p, Image original, boolean openedNode) {

            if (openedNode)

                return icon2;

            else

                return icon3;

        }

        @Override

        public void addChangeListener(ChangeListener listener) {

        }

        @Override

        public void removeChangeListener(ChangeListener listener) {

        }

    }

}