/*

 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.

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

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

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

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.swing;

import java.io.*;

import java.awt.BorderLayout;

import java.awt.Frame;

import java.awt.Dialog;

import java.awt.Window;

import java.awt.Component;

import java.awt.Container;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.awt.event.WindowListener;

import java.awt.event.WindowAdapter;

import java.awt.event.WindowEvent;

import java.awt.IllegalComponentStateException;

import java.awt.Point;

import java.awt.Rectangle;

import java.text.*;

import java.util.Locale;

import javax.accessibility.*;

import javax.swing.event.*;

import javax.swing.text.*;

/** A class to monitor the progress of some operation. If it looks

 * like the operation will take a while, a progress dialog will be popped up.

 * When the ProgressMonitor is created it is given a numeric range and a

 * descriptive string. As the operation progresses, call the setProgress method

 * to indicate how far along the [min,max] range the operation is.

 * Initially, there is no ProgressDialog. After the first millisToDecideToPopup

 * milliseconds (default 500) the progress monitor will predict how long

 * the operation will take.  If it is longer than millisToPopup (default 2000,

 * 2 seconds) a ProgressDialog will be popped up.

 * <p>

 * From time to time, when the Dialog box is visible, the progress bar will

 * be updated when setProgress is called.  setProgress won't always update

 * the progress bar, it will only be done if the amount of progress is

 * visibly significant.

 *

 * <p>

 *

 * For further documentation and examples see

 * <a

 href="http://docs.oracle.com/javase/tutorial/uiswing/components/progress.html">How to Monitor Progress</a>,

 * a section in <em>The Java Tutorial.</em>

 *

 * @see ProgressMonitorInputStream

 * @author James Gosling

 * @author Lynn Monsanto (accessibility)

 */

public class ProgressMonitor implements Accessible

{

    private ProgressMonitor root;

    private JDialog         dialog;

    private JOptionPane     pane;

    private JProgressBar    myBar;

    private JLabel          noteLabel;

    private Component       parentComponent;

    private String          note;

    private Object[]        cancelOption = null;

    private Object          message;

    private long            T0;

    private int             millisToDecideToPopup = 500;

    private int             millisToPopup = 2000;

    private int             min;

    private int             max;

    /**

     * Constructs a graphic object that shows progress, typically by filling

     * in a rectangular bar as the process nears completion.

     *

     * @param parentComponent the parent component for the dialog box

     * @param message a descriptive message that will be shown

     *        to the user to indicate what operation is being monitored.

     *        This does not change as the operation progresses.

     *        See the message parameters to methods in

     *        {@link JOptionPane#message}

     *        for the range of values.

     * @param note a short note describing the state of the

     *        operation.  As the operation progresses, you can call

     *        setNote to change the note displayed.  This is used,

     *        for example, in operations that iterate through a

     *        list of files to show the name of the file being processes.

     *        If note is initially null, there will be no note line

     *        in the dialog box and setNote will be ineffective

     * @param min the lower bound of the range

     * @param max the upper bound of the range

     * @see JDialog

     * @see JOptionPane

     */

    public ProgressMonitor(Component parentComponent,

                           Object message,

                           String note,

                           int min,

                           int max) {

        this(parentComponent, message, note, min, max, null);

    }

    private ProgressMonitor(Component parentComponent,

                            Object message,

                            String note,

                            int min,

                            int max,

                            ProgressMonitor group) {

        this.min = min;

        this.max = max;

        this.parentComponent = parentComponent;

        cancelOption = new Object[1];

        cancelOption[0] = UIManager.getString("OptionPane.cancelButtonText");

        this.message = message;

        this.note = note;

        if (group != null) {

            root = (group.root != null) ? group.root : group;

            T0 = root.T0;

            dialog = root.dialog;

        }

        else {

            T0 = System.currentTimeMillis();

        }

    }

    @SuppressWarnings("serial") // Superclass is not serializable across versions

    private class ProgressOptionPane extends JOptionPane

    {

        ProgressOptionPane(Object messageList) {

            super(messageList,

                  JOptionPane.INFORMATION_MESSAGE,

                  JOptionPane.DEFAULT_OPTION,

                  null,

                  ProgressMonitor.this.cancelOption,

                  null);

        }

        public int getMaxCharactersPerLineCount() {

            return 60;

        }

        // Equivalent to JOptionPane.createDialog,

        // but create a modeless dialog.

        // This is necessary because the Solaris implementation doesn't

        // support Dialog.setModal yet.

        public JDialog createDialog(Component parentComponent, String title) {

            final JDialog dialog;

            Window window = JOptionPane.getWindowForComponent(parentComponent);

            if (window instanceof Frame) {

                dialog = new JDialog((Frame)window, title, false);

            } else {

                dialog = new JDialog((Dialog)window, title, false);

            }

            if (window instanceof SwingUtilities.SharedOwnerFrame) {

                WindowListener ownerShutdownListener =

                        SwingUtilities.getSharedOwnerFrameShutdownListener();

                dialog.addWindowListener(ownerShutdownListener);

            }

            Container contentPane = dialog.getContentPane();

            contentPane.setLayout(new BorderLayout());

            contentPane.add(this, BorderLayout.CENTER);

            dialog.pack();

            dialog.setLocationRelativeTo(parentComponent);

            dialog.addWindowListener(new WindowAdapter() {

                boolean gotFocus = false;

                public void windowClosing(WindowEvent we) {

                    setValue(cancelOption[0]);

                }

                public void windowActivated(WindowEvent we) {

                    // Once window gets focus, set initial focus

                    if (!gotFocus) {

                        selectInitialValue();

                        gotFocus = true;

                    }

                }

            });

            addPropertyChangeListener(new PropertyChangeListener() {

                public void propertyChange(PropertyChangeEvent event) {

                    if(dialog.isVisible() &&

                       event.getSource() == ProgressOptionPane.this &&

                       (event.getPropertyName().equals(VALUE_PROPERTY) ||

                        event.getPropertyName().equals(INPUT_VALUE_PROPERTY))){

                        dialog.setVisible(false);

                        dialog.dispose();

                    }

                }

            });

            return dialog;

        }

        /////////////////

        // Accessibility support for ProgressOptionPane

        ////////////////

        /**

         * Gets the AccessibleContext for the ProgressOptionPane

         *

         * @return the AccessibleContext for the ProgressOptionPane

         * @since 1.5

         */

        public AccessibleContext getAccessibleContext() {

            return ProgressMonitor.this.getAccessibleContext();

        }

        /*

         * Returns the AccessibleJOptionPane

         */

        private AccessibleContext getAccessibleJOptionPane() {

            return super.getAccessibleContext();

        }

    }

    /**

     * Indicate the progress of the operation being monitored.

     * If the specified value is >= the maximum, the progress

     * monitor is closed.

     * @param nv an int specifying the current value, between the

     *        maximum and minimum specified for this component

     * @see #setMinimum

     * @see #setMaximum

     * @see #close

     */

    public void setProgress(int nv) {

        if (nv >= max) {

            close();

        }

        else {

            if (myBar != null) {

                myBar.setValue(nv);

            }

            else {

                long T = System.currentTimeMillis();

                long dT = (int)(T-T0);

                if (dT >= millisToDecideToPopup) {

                    int predictedCompletionTime;

                    if (nv > min) {

                        predictedCompletionTime = (int)(dT *

                                                        (max - min) /

                                                        (nv - min));

                    }

                    else {

                        predictedCompletionTime = millisToPopup;

                    }

                    if (predictedCompletionTime >= millisToPopup) {

                        myBar = new JProgressBar();

                        myBar.setMinimum(min);

                        myBar.setMaximum(max);

                        myBar.setValue(nv);

                        if (note != null) noteLabel = new JLabel(note);

                        pane = new ProgressOptionPane(new Object[] {message,

                                                                    noteLabel,

                                                                    myBar});

                        dialog = pane.createDialog(parentComponent,

                            UIManager.getString(

                                "ProgressMonitor.progressText"));

                        dialog.show();

                    }

                }

            }

        }

    }

    /**

     * Indicate that the operation is complete.  This happens automatically

     * when the value set by setProgress is >= max, but it may be called

     * earlier if the operation ends early.

     */

    public void close() {

        if (dialog != null) {

            dialog.setVisible(false);

            dialog.dispose();

            dialog = null;

            pane = null;

            myBar = null;

        }

    }

    /**

     * Returns the minimum value -- the lower end of the progress value.

     *

     * @return an int representing the minimum value

     * @see #setMinimum

     */

    public int getMinimum() {

        return min;

    }

    /**

     * Specifies the minimum value.

     *

     * @param m  an int specifying the minimum value

     * @see #getMinimum

     */

    public void setMinimum(int m) {

        if (myBar != null) {

            myBar.setMinimum(m);

        }

        min = m;

    }

    /**

     * Returns the maximum value -- the higher end of the progress value.

     *

     * @return an int representing the maximum value

     * @see #setMaximum

     */

    public int getMaximum() {

        return max;

    }

    /**

     * Specifies the maximum value.

     *

     * @param m  an int specifying the maximum value

     * @see #getMaximum

     */

    public void setMaximum(int m) {

        if (myBar != null) {

            myBar.setMaximum(m);

        }

        max = m;

    }

    /**

     * Returns true if the user hits the Cancel button in the progress dialog.

     */

    public boolean isCanceled() {

        if (pane == null) return false;

        Object v = pane.getValue();

        return ((v != null) &&

                (cancelOption.length == 1) &&

                (v.equals(cancelOption[0])));

    }

    /**

     * Specifies the amount of time to wait before deciding whether or

     * not to popup a progress monitor.

     *

     * @param millisToDecideToPopup  an int specifying the time to wait,

     *        in milliseconds

     * @see #getMillisToDecideToPopup

     */

    public void setMillisToDecideToPopup(int millisToDecideToPopup) {

        this.millisToDecideToPopup = millisToDecideToPopup;

    }

    /**

     * Returns the amount of time this object waits before deciding whether

     * or not to popup a progress monitor.

     *

     * @see #setMillisToDecideToPopup

     */

    public int getMillisToDecideToPopup() {

        return millisToDecideToPopup;

    }

    /**

     * Specifies the amount of time it will take for the popup to appear.

     * (If the predicted time remaining is less than this time, the popup

     * won't be displayed.)

     *

     * @param millisToPopup  an int specifying the time in milliseconds

     * @see #getMillisToPopup

     */

    public void setMillisToPopup(int millisToPopup) {

        this.millisToPopup = millisToPopup;

    }

    /**

     * Returns the amount of time it will take for the popup to appear.

     *

     * @see #setMillisToPopup

     */

    public int getMillisToPopup() {

        return millisToPopup;

    }

    /**

     * Specifies the additional note that is displayed along with the

     * progress message. Used, for example, to show which file the

     * is currently being copied during a multiple-file copy.

     *

     * @param note  a String specifying the note to display

     * @see #getNote

     */

    public void setNote(String note) {

        this.note = note;

        if (noteLabel != null) {

            noteLabel.setText(note);

        }

    }

    /**

     * Specifies the additional note that is displayed along with the

     * progress message.

     *

     * @return a String specifying the note to display

     * @see #setNote

     */

    public String getNote() {

        return note;

    }

    /////////////////

    // Accessibility support

    ////////////////

    /**

     * The <code>AccessibleContext</code> for the <code>ProgressMonitor</code>

     * @since 1.5

     */

    protected AccessibleContext accessibleContext = null;

    private AccessibleContext accessibleJOptionPane = null;

    /**

     * Gets the <code>AccessibleContext</code> for the

     * <code>ProgressMonitor</code>

     *

     * @return the <code>AccessibleContext</code> for the

     * <code>ProgressMonitor</code>

     * @since 1.5

     */

    public AccessibleContext getAccessibleContext() {

        if (accessibleContext == null) {

            accessibleContext = new AccessibleProgressMonitor();

        }

        if (pane != null && accessibleJOptionPane == null) {

            // Notify the AccessibleProgressMonitor that the

            // ProgressOptionPane was created. It is necessary

            // to poll for ProgressOptionPane creation because

            // the ProgressMonitor does not have a Component

            // to add a listener to until the ProgressOptionPane

            // is created.

            if (accessibleContext instanceof AccessibleProgressMonitor) {

                ((AccessibleProgressMonitor)accessibleContext).optionPaneCreated();

            }

        }

        return accessibleContext;

    }

    /**

     * <code>AccessibleProgressMonitor</code> implements accessibility

     * support for the <code>ProgressMonitor</code> class.

     * @since 1.5

     */

    protected class AccessibleProgressMonitor extends AccessibleContext

        implements AccessibleText, ChangeListener, PropertyChangeListener {

        /*

         * The accessibility hierarchy for ProgressMonitor is a flattened

         * version of the ProgressOptionPane component hierarchy.

         *

         * The ProgressOptionPane component hierarchy is:

         *   JDialog

         *     ProgressOptionPane

         *       JPanel

         *         JPanel

         *           JLabel

         *           JLabel

         *           JProgressBar

         *

         * The AccessibleProgessMonitor accessibility hierarchy is:

         *   AccessibleJDialog

         *     AccessibleProgressMonitor

         *       AccessibleJLabel

         *       AccessibleJLabel

         *       AccessibleJProgressBar

         *

         * The abstraction presented to assitive technologies by

         * the AccessibleProgressMonitor is that a dialog contains a

         * progress monitor with three children: a message, a note

         * label and a progress bar.

         */