<changes>

    <change id="customDialogs">

        <api name="progress_api"/>

        <summary><code>ProgressUtils</code> class with <code>runOffEventThreadWithCustomDialogContent</code> and <code>runOffEventThreadWithProgressDialog</code> methods were added.</summary>

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

        <date day="28" month="8" year="2012"/>

        <author login="pflaska	"/>

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

        <description><code>ProgressUtils</code> class with <code>runOffEventThreadWithCustomDialogContent</code> and <code>runOffEventThreadWithProgressDialog</code> methods were added. These methods allow movement of operations out of AWT thread, showing the waint cursor after one second and a dialog when task is not finished in a three seconds.

        </description>

        <class package="org.netbeans.api.progress" name="ProgressUtils"/>

        <issue number="204553"/>

    </change>

import javax.swing.JPanel;

import org.netbeans.modules.progress.spi.RunOffEDTProvider.Progress2;

     * Runs operation out of the event thread, blocking the whole UI. When

     * operation takes more than 1s, the method first displays wait cursor.

     * If operation will not end in 3s interval, modal dialog with

     * progress is shown up.

     * If operation is marked with {@link org.openide.util.Cancellable}

     * interface, cancel button is part of dialog and can be used 

     * to interrupt the operation.

     * 

     * @param operation  task to perform in the background

     * @param dialogTitle dialog title

     * @param progress  progress handle. Do not invoke any methods before

     *                  passing to this method. Start/progress/finish it

     *                  only in {@code operation}

     * @param includeDetailLabel  show progress detail label in the dialog

     * @param waitCursorAfter amount of time, in milliseconds, after which wait

     *                        cursor is shown

     * @param dialogAfter amount of time, in milliseconds, after which dialog

     *                    is shown

     * 

     * @since 1.30

     */

    public static void runOffEventThreadWithProgressDialog(

            final Runnable operation,

            final String dialogTitle, 

            final ProgressHandle progress, 

            final boolean includeDetailLabel,

            int waitCursorAfter,

            int dialogAfter)

    {

        if (PROVIDER instanceof Progress2) {

            Progress2 p = (Progress2) PROVIDER;

            p.runOffEventThreadWithProgressDialog(operation, dialogTitle, progress, includeDetailLabel, waitCursorAfter, dialogAfter);

        } else {

            PROVIDER.runOffEventDispatchThread(operation, progress.getDisplayName(),

                    new AtomicBoolean(false),

                    true,

                    DISPLAY_WAIT_CURSOR_MS,

                    DISPLAY_DIALOG_MS);

        }

    }

    /**

     * Runs operation out of the event thread, blocking the whole UI. When

     * operation takes more than 1s, the method first displays wait cursor.

     * If operation will not end up in 3s interval, modal dialog with

     * {@code content} panel is shown.

     * If operation is marked with {@link org.openide.util.Cancellable} 

     * interface, cancel button is part of dialog and can be used to 

     * interrupt the operation.

     * 

     * @param operation  task to perform in the background

     * @param dialogTitle dialog title

     * @param content  panel to be shown in the dialog

     * @param waitCursorAfter amount of time, in milliseconds, after which wait

     *                        cursor is shown

     * @param dialogAfter amount of time, in milliseconds, after which dialog

     *                    is shown

     * 

     * @since 1.30

     */

    public static void runOffEventThreadWithCustomDialogContent(

            final Runnable operation,

            final String dialogTitle,

            final JPanel content,

            int waitCursorAfter,

            int dialogAfter)

    {

        if (PROVIDER instanceof Progress2) {

            Progress2 p = (Progress2) PROVIDER;

            p.runOffEventThreadWithCustomDialogContent(operation, dialogTitle, content, waitCursorAfter, dialogAfter);

        } else {

            PROVIDER.runOffEventDispatchThread(operation, 

                    dialogTitle, 

                    new AtomicBoolean(false),

                    true, 

                    DISPLAY_WAIT_CURSOR_MS,

                    DISPLAY_DIALOG_MS);

        }

    }

    /**

        @Override

import javax.swing.JPanel;

    public interface Progress2 extends Progress {

        /**

         * Runs operation out of the event thread, blocking the whole UI. When

         * operation takes more than 1s, the method first displays wait cursor.

         * If operation will not end in 3s interval, modal dialog with

         * progress is shown up.

         * If operation is marked with {@link org.openide.util.Cancellable}

         * interface, cancel button is part of dialog and can be used 

         * to interrupt the operation.

         * 

         * @param operation  task to perform in the background

         * @param dialogTitle dialog title

         * @param progress  progress handle. Do not invoke any methods before

         *                  passing to this method. Start/progress/finish it

         *                  only in {@code operation}

         * @param includeDetailLabel  show progress detail label in the dialog

         * @param waitCursorAfter amount of time, in milliseconds, after which 

         *                        wait cursor is shown

         * @param dialogAfter amount of time, in milliseconds, after which 

         *                    dialog is shown

         * 

         * @since 1.30

         */

        public void runOffEventThreadWithProgressDialog(

            final Runnable operation, 

            final String operationDescr,

            final ProgressHandle progress, 

            final boolean includeDetailLabel,

            int waitCursorAfter,

            int dialogAfter);

        /**

         * Runs operation out of the event thread, blocking the whole UI. When

         * operation takes more than 1s, the method first displays wait cursor.

         * If operation will not end up in 3s interval, modal dialog with

         * {@code content} panel is shown.

         * If operation is marked with {@link org.openide.util.Cancellable} 

         * interface, cancel button is part of dialog and can be used to 

         * interrupt the operation.

         * 

         * @param operation  task to perform in the background

         * @param dialogTitle dialog title

         * @param content  panel to be shown in the dialog

         * @param waitCursorAfter amount of time, in milliseconds, after which 

         *                        wait cursor is shown

         * @param dialogAfter amount of time, in milliseconds, after which 

         *                    dialog is shown

         * 

         * @since 1.30

         */

        public void runOffEventThreadWithCustomDialogContent(

            final Runnable operation,

            final String dialogTitle,

            final JPanel content,

            int waitCursorAfter,

            int dialogAfter);

        }

import org.netbeans.modules.progress.spi.RunOffEDTProvider.Progress2;

    private static final RequestProcessor TI_WORKER = new RequestProcessor("TI_" + ProgressUtils.class.getName(), 1, true);

    @Override

    public void runOffEventThreadWithCustomDialogContent(Runnable operation, String dialogTitle, JPanel content, int waitCursorAfter, int dialogAfter)

    {

        runOffEventThreadCustomDialogImpl(operation, dialogTitle, content, waitCursorAfter, dialogAfter);

    }

    @Override

    public void runOffEventThreadWithProgressDialog(final Runnable operation, final String operationDescr,

            ProgressHandle handle, boolean includeDetailLabel, int waitCursorAfter, int dialogAfter) {

        JPanel content = contentPanel(handle, includeDetailLabel);

        runOffEventThreadCustomDialogImpl(operation, operationDescr, content, waitCursorAfter, dialogAfter);

    }

    private void runOffEventThreadCustomDialogImpl(final Runnable operation, final String operationDescr,

            final JPanel contentPanel, int waitCursorAfter, int dialogAfter) {

        if (waitCursorAfter < 0) waitCursorAfter = 1000;

        if (dialogAfter < 0) dialogAfter = 2000;

        final CountDownLatch latch = new CountDownLatch(1);

        final AtomicReference<Dialog> d = new AtomicReference<Dialog>();

        final AtomicReference<RequestProcessor.Task> t  = new AtomicReference<RequestProcessor.Task>();

        JDialog dialog = createModalDialog(operation, operationDescr, contentPanel, d, t, operation instanceof Cancellable);

        final Task rt = TI_WORKER.post(new Runnable() {

            public @Override void run() {

		try {

		    operation.run();

		} finally {

		    latch.countDown();

		    SwingUtilities.invokeLater(new Runnable() {

			public @Override void run() {

			    Dialog dd = d.get();

			    if (dd != null) {

				dd.setVisible(false);

				dd.dispose();

			    }

			}

		    });

		}

            }

        });

        t.set(rt);

        Window window = null;

        Component glassPane = null;

        Component focusOwner = KeyboardFocusManager.getCurrentKeyboardFocusManager().getFocusOwner();

        if (focusOwner != null) {

            window = SwingUtilities.getWindowAncestor(focusOwner);

            if (window != null) {

                RootPaneContainer root = (RootPaneContainer) SwingUtilities.getAncestorOfClass(RootPaneContainer.class, focusOwner);

                glassPane = root.getGlassPane();   

            }

        } 

        if (window == null || glassPane == null) {

            window = WindowManager.getDefault().getMainWindow();

            glassPane = ((JFrame) window).getGlassPane();

        }

        if (waitMomentarily(glassPane, null, waitCursorAfter, latch, window)) {

            return;

        }

        Cursor wait = Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR);

        if (waitMomentarily(glassPane, wait, dialogAfter, latch, window)) {

            return;

        }

        d.set(dialog);

        if (EventQueue.isDispatchThread()) {

            EventQueue.invokeLater(new Runnable() {

                @Override

                public void run() {

                    d.get().setVisible(true);

                }

            });

        } else {

            d.get().setVisible(true);

        }

    }

    private static JPanel contentPanel(final ProgressHandle handle, boolean includeDetail) {

        // top panel

        JPanel contentPanel = new JPanel(new GridBagLayout());

        // main label

        GridBagConstraints gridBagConstraints = new GridBagConstraints();

        gridBagConstraints.insets = new java.awt.Insets(5, 5, 0, 0);

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 0;

        gridBagConstraints.anchor = java.awt.GridBagConstraints.LINE_START;

        JLabel mainLabel = ProgressHandleFactory.createMainLabelComponent(handle);

        Font f = mainLabel.getFont();

        if (f != null) {

            mainLabel.setFont(f.deriveFont(Font.BOLD));

        }

        contentPanel.add(mainLabel, gridBagConstraints);

        // progress bar

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.insets = new java.awt.Insets(5, 5, 0, 0);

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 1;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        JComponent progressBar = ProgressHandleFactory.createProgressComponent(handle);

        contentPanel.add (progressBar, gridBagConstraints);

        if (includeDetail) {

            gridBagConstraints = new java.awt.GridBagConstraints();

            gridBagConstraints.insets = new java.awt.Insets(5, 5, 0, 0);

            gridBagConstraints.gridx = 0;

            gridBagConstraints.gridy = 2;

            gridBagConstraints.anchor = java.awt.GridBagConstraints.LINE_START;

            JLabel details = ProgressHandleFactory.createDetailLabelComponent(handle);

            contentPanel.add(details, gridBagConstraints);

        }

        // empty panel - for correct resizing

        JPanel emptyPanel = new JPanel();

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = includeDetail ? 3 : 2;

        gridBagConstraints.weighty = 2.0;

        gridBagConstraints.weightx = 2.0;

        gridBagConstraints.fill = java.awt.GridBagConstraints.BOTH;

        contentPanel.add(emptyPanel, gridBagConstraints);

        return contentPanel;

    }

    private static JDialog createModalDialog(

            final Runnable operation,

            final String title,

            final JPanel content,

            final AtomicReference<Dialog> d,

            final AtomicReference<RequestProcessor.Task> task,

            final boolean cancelAvail) 

    {

        assert EventQueue.isDispatchThread();

        JPanel panel = new JPanel(new GridBagLayout());

        GridBagConstraints gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridx = 0;

        gridBagConstraints.gridy = 0;

        gridBagConstraints.weightx = 1.0;

        gridBagConstraints.weighty = 1.0;

        gridBagConstraints.fill = java.awt.GridBagConstraints.BOTH;

        panel.add(content, gridBagConstraints);

        if (cancelAvail) {

            JPanel buttonsPanel = new JPanel();

            buttonsPanel.setLayout(new FlowLayout(FlowLayout.RIGHT));

            String cancelButton = NbBundle.getMessage(RunOffEDTImpl.class, "RunOffAWT.BTN_Cancel"); //NOI18N

            JButton cancel = new JButton(cancelButton);

            cancel.addActionListener(new ActionListener() {

                @Override

                public void actionPerformed(ActionEvent e) {

                    if (operation instanceof Cancellable) {

                        ((Cancellable) operation).cancel();

                        task.get().cancel();

                        d.get().setVisible(false);

                        d.get().dispose();

                    }

                }

            });

            buttonsPanel.add(cancel);

            gridBagConstraints = new java.awt.GridBagConstraints();

            gridBagConstraints.gridx = 0;

            gridBagConstraints.gridy = 1;

            gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

            gridBagConstraints.weightx = 1.0;

            panel.add(buttonsPanel, gridBagConstraints);

        }

        Frame mainWindow = WindowManager.getDefault().getMainWindow();

        final JDialog result = new JDialog(mainWindow, title, true);

        result.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);

        result.setSize(400, 150);

        result.setContentPane(panel);

        result.setLocationRelativeTo(WindowManager.getDefault().getMainWindow());

        return result;

    }