<?xml version="1.0" encoding="UTF-8"?>

<!-- Search for CHANGEME in this document when copying and using it: -->

<!--

The contents of this file are subject to the terms of the Common Development

and Distribution License (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.html

or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file

and include the License file at http://www.netbeans.org/cddl.txt.

If applicable, add the following below the CDDL Header, with the fields

enclosed by brackets [] replaced by your own identifying information:

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

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.

-->

<?xml-stylesheet type="text/xml" href="../../nbbuild/javadoctools/apichanges.xsl"?>

<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../nbbuild/javadoctools/apichanges.dtd">

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not

need to regenerate the HTML, as this is part of Javadoc generation; just

change the XML. Rough syntax of a change (several parts optional):

<change>

    <api name="compiler"/>

    <summary>Some brief description here, can use <b>XHTML</b></summary>

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

    <date day="13" month="6" year="2001"/>

    <author login="jrhacker"/>

    <compatibility addition="yes"/>

    <description>

        The main description of the change here.

        Again can use full <b>XHTML</b> as needed.

    </description>

    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>

    <issue number="14309"/>

</change>

Also permitted elements: <package>, <branch>. <version> is API spec

version, recommended for all new changes. <compatibility> should say

if things were added/modified/deprecated/etc. and give all information

related to upgrading old code. List affected top-level classes and

link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various

ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same

change on a stabilization branch, use the <branch> tag to indicate this

and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it

on branches if you want, but these changes will be ignored; only the

trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the

deprecated calls continues to see their documented behavior. But do

specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,

not describe the complete current behavior, for which ordinary documentation

is the proper place.

-->

<apichanges>

    <!-- First, a list of API names you may use: -->

    <apidefs>

        <apidef name="general">Java Source UI API</apidef>

        <!-- etc. -->

    </apidefs>

    <!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>

        <change id="ScanDialog">

            <api name="general"/>

            <summary>Added support for notifying user about running background scan.</summary>

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

            <date day="18" month="7" year="2007"/>

            <author login="tzezula"/>

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

            </compatibility>

            <description>

             Added support for notifying user about running background scan. When the 

            background scan is running the support displays a dialog notifying user about it.

            When the background scan finishes the dialog is closed and the action is executed.

            </description>

            <class package="org.netbeans.api.java.source.ui" name="ScanDialog"/>

            <issue number="97542"/>

        </change>

    </changes>

    <!-- Now the surrounding HTML text and document structure: -->

    <htmlcontents>

<!--

                            NO NO NO NO NO!

         ==============>    DO NOT EDIT ME!  <==============

          AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT

                SEE CHANGEME/apichanges.xml

-->

    <head>

      <title>Change History for the Java Source UI API</title>

      <link rel="stylesheet" href="prose.css" type="text/css"/>

    </head>

    <body>

<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the Java Source UI API<!--</a>-->.</p>

<!-- The actual lists of changes, as summaries and details: -->

      <hr/>

      <standard-changelists module-code-name="org.netbeans.modules.java.sourceui"/>

      <hr/><p>@FOOTER@</p>

    </body>

  </htmlcontents>

</apichanges>

                    <code-name-base>org.netbeans.modules.java.platform</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.9</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.dialogs</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.5</specification-version>

LBL_CancelAction=Cancel {0}

MSG_WaitScan=Please wait, classpath scanning in progress...

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (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.html

 * or http://www.netbeans.org/cddl.txt.

 * 

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

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

 * 

 * Portions Copyrighted 2007 Sun Microsystems, Inc.

 */

package org.netbeans.api.java.source.ui;

import java.awt.Dialog;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.io.IOException;

import java.net.URL;

import java.util.concurrent.Future;

import javax.swing.JLabel;

import javax.swing.SwingConstants;

import javax.swing.SwingUtilities;

import javax.swing.border.EmptyBorder;

import org.netbeans.api.java.platform.JavaPlatform;

import org.netbeans.api.java.source.ClasspathInfo;

import org.netbeans.api.java.source.CompilationController;

import org.netbeans.api.java.source.JavaSource;

import org.netbeans.api.java.source.SourceUtils;

import org.netbeans.api.java.source.Task;

import org.netbeans.spi.java.classpath.support.ClassPathSupport;

import org.openide.DialogDescriptor;

import org.openide.DialogDisplayer;

import org.openide.util.Exceptions;

import org.openide.util.NbBundle;

/**

 * Support for notifying user about the background scan.

 * @since 1.2

 * @author Tomas Zezula

 */

public class ScanDialog {

    /**

     * This is a helper method to provide support for delaying invocations of actions

     * depending on java model. 

     * <br>Behavior of this method is following:<br>

     * If classpath scanning is not in progress, runnable's run() is called. <br>

     * If classpath scanning is in progress, modal cancellable notification dialog with specified

     * tile is opened.

     * </ul>

     * As soon as classpath scanning finishes, this dialog is closed and runnable's run() is called.

     * This method must be called in AWT EventQueue. Runnable is performed in AWT thread.

     *

     * @param runnable Runnable instance which will be called.

     * @param actionName Title of wait dialog.

     * @return true action was cancelled <br>

     *         false action was performed

     */

    public static boolean runWhenScanFinished (final Runnable runnable, final String actionName) {

        assert runnable != null;

        assert actionName != null;

        assert SwingUtilities.isEventDispatchThread();

        if (SourceUtils.isScanInProgress()) {

            class AL implements ActionListener {

                private Dialog dialog;

                private Future<Void> monitor;

                public synchronized void start (final Future<Void> monitor) {

                    assert monitor != null; 

                    this.monitor = monitor;

                    if (dialog != null) {

                        dialog.setVisible(true);                                        

                    }

                }

                public void actionPerformed(ActionEvent e) {                    

                    monitor.cancel(false);

                    close ();

                }

                synchronized  void close () {

                    if (dialog != null) {

                        dialog.setVisible(false);

                        dialog.dispose();

                        dialog = null;

                    }

                }

            };

            final AL listener = new AL ();            

            JLabel label = new JLabel(NbBundle.getMessage(ScanDialog.class,"MSG_WaitScan"),

                    javax.swing.UIManager.getIcon("OptionPane.informationIcon"), SwingConstants.LEFT);

            label.setBorder(new EmptyBorder(12,12,11,11));

            DialogDescriptor dd = new DialogDescriptor(label, actionName, true, new Object[]{NbBundle.getMessage(ScanDialog.class,"LBL_CancelAction",actionName)}, null, 0, null, listener);

            listener.dialog = DialogDisplayer.getDefault().createDialog(dd);

            listener.dialog.pack();

            final ClasspathInfo info = ClasspathInfo.create(JavaPlatform.getDefault().getBootstrapLibraries(),

                ClassPathSupport.createClassPath(new URL[0]),

                ClassPathSupport.createClassPath(new URL[0]));

            final JavaSource js = JavaSource.create(info);

            try {

                Future<Void> monitor = js.runWhenScanFinished(new Task<CompilationController>() {

                    public void run(CompilationController parameter) throws Exception {

                        SwingUtilities.invokeLater(new Runnable () {

                            public void run () {

                                listener.close();

                                runnable.run();

                            }

                        });                        

                    }

                }, true);

                if (!monitor.isDone()) {

                    listener.start(monitor);                       

                }

                return monitor.isCancelled();

            }catch (IOException e) {

                Exceptions.printStackTrace(e);

                return true;

            }

        } else {

            runnable.run();

            return false;

        }

    }

}