/* Editable plotter application that is capable of reading PlotML files.

 @Author: Edward A. Lee

 @Version: $Id$

 @Copyright (c) 1997-2014 The Regents of the University of California.
 All rights reserved.

 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the
 above copyright notice and the following two paragraphs appear in all
 copies of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY
 */
package ptolemy.plot.plotml;

import java.awt.Event;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;

import javax.swing.JComponent;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.KeyStroke;
import javax.swing.SwingUtilities;

import ptolemy.gui.ComponentDialog;
import ptolemy.gui.Query;
import ptolemy.plot.EditablePlot;
import ptolemy.plot.PlotBox;
import ptolemy.util.StringUtilities;

///////////////////////////////////////////////////////////////////
//// EditablePlotMLApplication

/**
 An application that can plot data in PlotML format from a URL or
 from files specified on the command line, and can then permit the
 user to edit the plot.
 To compile and run this application, do the following:
 <pre>
 javac -classpath ../../.. EditablePlotMLApplication.java
 java -classpath ../../.. ptolemy.plot.plotml.EditablePlotMLApplication
 </pre>
 Initially, none of the data sets is editable. Use the Edit menu's
 Edit Dataset item to make a data set editable.

 @author Edward A. Lee
 @version $Id$
 @since Ptolemy II 0.4
 @Pt.ProposedRating red (eal)
 @Pt.AcceptedRating red (cxh)
 @see ptolemy.plot.PlotBox
 @see ptolemy.plot.Plot
 */
@SuppressWarnings("serial")
public class EditablePlotMLApplication extends PlotMLApplication {
    /** Construct a plot with no command-line arguments.
     *  It initially displays a sample plot.
     *  @exception Exception If command line arguments have problems.
     */
    public EditablePlotMLApplication() throws Exception {
        this(null);
    }

    /** Construct a plot with the specified command-line arguments.
     *  @param args The command-line arguments.
     *  @exception Exception If command line arguments have problems.
     */
    public EditablePlotMLApplication(String[] args) throws Exception {
        this(new EditablePlot(), args);
    }

    /** Construct a plot with the specified command-line arguments
     *  and instance of plot.
     *  @param plot The instance of EditablePlot to use.
     *  @param args The command-line arguments.
     *  @exception Exception If command line arguments have problems.
     */
    public EditablePlotMLApplication(EditablePlot plot, String[] args)
            throws Exception {
        super(plot, args);

        // The default is that no set is editable.
        plot.setEditable(-1);

        // Edit menu
        JMenuItem select = new JMenuItem("Edit Dataset", KeyEvent.VK_E);
        SelectListener selectListener = new SelectListener();
        select.addActionListener(selectListener);

        // Note that under Windows, the setLookAndFeel() in
        // PlotApplication causes problems here with this new
        // JMenuItem: the font and background color may be wrong.
        // Setting the background works here because the parent
        // class has called setVisible() already.
        // Unfortunately, setting the background helps, but the
        // result does not have the etch border
        //select.setBorderPainted(true);
        //select.setBorder(javax.swing.BorderFactory.createMatteBorder(0,1,0,0,java.awt.Color.white));
        //select.setBackground(_editMenu.getBackground());
        // Under Java 1.3.1_06, at least the font is right, but not
        // under 1.4.1_02
        //select.setFont(_editMenu.getFont());
        // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4736093
        // suggests this, which does not seem to help
        getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
                KeyStroke.getKeyStroke(KeyEvent.VK_ALT, Event.ALT_MASK, false),
                "repaint");

        _editMenu.add(select);

        // http://java.sun.com/docs/books/tutorial/uiswing/misc/plaf.html
        // suggests calling updateComponentTreeUI(), but if we do,
        // that forces the menu back to a white background.
        //SwingUtilities.updateComponentTreeUI(select);
    }

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /** Create a new plot window and map it to the screen.
     *  The command to run would be:
     *  <pre>
     *  java -classpath $PTII ptolemy.plot.plotml.EditablePlotMLApplication
     *  </pre>
     *  @param args Arguments suitable for the
     *  {@link ptolemy.plot.EditablePlot} class.
     */
    public static void main(final String[] args) {
        try {
            Runnable doActions = new Runnable() {
                @Override
                public void run() {
                    try {
                        new EditablePlotMLApplication(new EditablePlot(), args);
                    } catch (Exception ex) {
                        System.err.println(ex.toString());
                        ex.printStackTrace();
                    }
                }
            };

            // NOTE: Using invokeAndWait() here risks causing
            // deadlock.  However, the Sun Tutorial recommends calling
            // invokeAndWait so that the work finishes before returning.
            // if we call invokeLater() then demo/PlotFourierSeries.java
            // has problems.
            SwingUtilities.invokeAndWait(doActions);
        } catch (Exception ex) {
            System.err.println(ex.toString());
            ex.printStackTrace();
        }

        // If the -test arg was set, then exit after 2 seconds.
        if (_test) {
            try {
                Thread.sleep(2000);
            } catch (InterruptedException e) {
            }

            StringUtilities.exit(0);
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                         protected methods                 ////

    /** Display basic information about the application.
     */
    @Override
    protected void _about() {
        JOptionPane.showMessageDialog(this,
                "EditablePlotMLApplication class\n" + "By: Edward A. Lee "
                        + "and Christopher Hylands\n" + "Version "
                        + PlotBox.PTPLOT_RELEASE + ", Build: $Id$\n\n"
                        + "For more information, see\n"
                        + "http://ptolemy.eecs.berkeley.edu/java/ptplot\n\n"
                        + "Copyright (c) 1997-2014, "
                        + "The Regents of the University of California.",
                "About Ptolemy Plot", JOptionPane.INFORMATION_MESSAGE);
    }

    /** Display more detailed information than given by _about().
     */
    @Override
    protected void _help() {
        JOptionPane.showMessageDialog(this,
                "EditablePlotMLApplication is a standalone plot "
                        + " application.\n"
                        + "  File formats understood: PlotML and Ptplot ASCII.\n"
                        + "  Left mouse button: Zooming.\n"
                        + "  Right mouse button: Editing data (use edit menu to select "
                        + "a dataset).\n\n" + _usage(),
                "About Ptolemy Plot", JOptionPane.INFORMATION_MESSAGE);
    }

    /** Open a dialog to select a dataset to edit.
     */
    protected void _selectDataset() {
        Query query = new Query();
        int numSets = ((EditablePlot) plot).getNumDataSets();
        String[] choices = new String[numSets + 1];

        for (int i = 0; i < numSets; i++) {
            choices[i + 1] = plot.getLegend(i);

            if (choices[i + 1] == null) {
                choices[i + 1] = "" + i;
            }
        }

        choices[0] = "none";
        query.setTextWidth(20);
        query.addChoice("choice",
                "Choose a data set, then drag the right mouse button", choices,
                choices[0]);

        ComponentDialog dialog = new ComponentDialog(this, "Select dataset",
                query);
        String buttonPressed = dialog.buttonPressed();

        if (buttonPressed.equals("OK")) {
            int result = query.getIntValue("choice");

            if (result > 0) {
                ((EditablePlot) plot).setEditable(result - 1);
            } else {
                // none...
                ((EditablePlot) plot).setEditable(-1);
            }
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                         inner classes                     ////
    class SelectListener implements ActionListener {
        @Override
        public void actionPerformed(ActionEvent e) {
            _selectDataset();
        }
    }
}