<change id="slowRename">

        <api name="explorer"/>

        <summary>In-place rename can be processed on background</summary>

        <version major="6" minor="37"/>

        <date day="23" month="6" year="2011"/>

        <author login="jtulach"/>

        <compatibility binary="compatible" source="compatible" deprecation="no" deletion="no" addition="yes"/>

        <description>

            By providing <a href="@TOP@/architecture-summary.html#property-slowRename">slowRename</a>

            property, nodes can request in-place rename to be finished on background.

        </description>

        <class package="org.openide.explorer.view" name="TreeView"/>

        <class package="org.openide.explorer.view" name="TreeTableView"/>

        <class package="org.openide.explorer.view" name="OutlineView"/>

        <issue number="190736"/>

    </change>

    <api name="slowRename" group="property" category="devel" type="export">

    Nodes returing Boolean.TRUE from getValue("slowRename") are expected

    to have potentially slow implemenation of <code>setName</code>. Explorer views

    rather process in-place rename in background for such nodes.

    </api>

import java.util.MissingResourceException;

import java.awt.EventQueue;

import org.openide.nodes.Node;

import org.openide.util.Exceptions;

import org.openide.util.NbBundle;

    static void nodeRename(final Node n, final String newStr) {

        // bugfix #21589 don't update name if there is not any change

        if (n.getName().equals(newStr)) {

            return;

        }

        if (EventQueue.isDispatchThread() && Boolean.TRUE.equals(n.getValue("slowRename"))) { // NOI18N

            RP.post(new Runnable() {

                @Override

                public void run() {

                    nodeRename(n, newStr);

                }

            });

            return;

        }

        try {

            n.setName(newStr);

        } catch (IllegalArgumentException exc) {

            boolean needToAnnotate = Exceptions.findLocalizedMessage(exc) == null;

            // annotate new localized message only if there is no localized message yet

            if (needToAnnotate) {

                String msg = NbBundle.getMessage(

                        TreeViewCellEditor.class, "RenameFailed", n.getName(), newStr

                    );

                Exceptions.attachLocalizedMessage(exc, msg);

            }

            Exceptions.printStackTrace(exc);

        }

    }

/*

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

 *

 * Copyright 2011 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]"

 *

 * 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.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.openide.explorer.view;

import java.awt.EventQueue;

import org.netbeans.junit.NbTestCase;

import org.openide.nodes.AbstractNode;

import org.openide.nodes.Children;

import org.openide.nodes.Node;

import org.openide.util.Exceptions;

public class ViewUtilTest extends NbTestCase {

    public ViewUtilTest(String n) {

        super(n);

    }

    @Override

    protected boolean runInEQ() {

        return true;

    }

    @Override

    protected int timeOut() {

        return 20000;

    }

    public void testRenameNormalNode() {

        Node n = new AbstractNode(Children.LEAF) {

            @Override

            public void setName(String s) {

                assertTrue("In AWT", EventQueue.isDispatchThread());

                super.setName(s);

            }

        };

        n.setName("newName");

        assertEquals("newName", n.getName());

    }

    public void testRenameForSlowNode() {

        Node n = new AbstractNode(Children.LEAF) {

            boolean renamed;

            @Override

            public synchronized void setName(String s) {

                renamed = true;

                notifyAll();

                assertFalse("Not in AWT", EventQueue.isDispatchThread());

                super.setName(s);

            }

            @Override

            public synchronized String toString() {

                while (!renamed) {

                    try {

                        wait();

                    } catch (InterruptedException ex) {

                        Exceptions.printStackTrace(ex);

                    }

                }

                return super.getName();

            }

        };

        n.setValue("slowRename", true);

        ViewUtil.nodeRename(n, "newName");

        assertEquals("newName", n.toString());

    }

}

        @Override

        public Object getValue(String attributeName) {

            if ("slowRename".equals(attributeName)) { // NOI18N

                if (getRenameHandler() != null) {

                    return Boolean.TRUE;

                }

            }

            return super.getValue(attributeName);

        }

    public void testRenameSlow() throws DataObjectNotFoundException, IOException {

        FileObject root = FileUtil.createMemoryFileSystem().getRoot();

        DataObject obj = DataObject.find(root);

        Node n = obj.getNodeDelegate();

        assertNull("not slow rename by default", n.getValue("slowRename"));

        registerIntoLookup(new MyHandler());

        assertEquals("now rename is slow", Boolean.TRUE, n.getValue("slowRename"));

    }

    private static final class MyHandler implements FolderRenameHandler {

        @Override

        public void handleRename(DataFolder folder, String newName) throws IllegalArgumentException {

        }

    }