/* A text editor to edit a string attribute.

 Copyright (c) 2003-2016 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.vergil.toolbox;

import java.awt.event.KeyEvent;

import javax.swing.JOptionPane;
import javax.swing.text.Document;

import ptolemy.actor.gui.TextEditor;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.NamedObj;
import ptolemy.moml.MoMLChangeRequest;
import ptolemy.util.StringUtilities;

/**
 A text editor to edit a specified string attribute or parameter.

 @author Edward A. Lee
 @version $Id$
 @since Ptolemy II 4.0
 @Pt.ProposedRating Yellow (eal)
 @Pt.AcceptedRating Red (ptolemy)
 */
@SuppressWarnings("serial")
public class TextEditorForStringAttributes extends TextEditor {

    /** Create a annotation text editor for the specified attribute.
     *  @param factory The factory that created this editor.
     *  @param attributeToEdit The string attribute to edit.
     *  @param rows The number of rows.
     *  @param columns The number of columns.
     *  @param title The window title to use.
     */
    public TextEditorForStringAttributes(TextEditorFactory factory,
            Attribute attributeToEdit, int rows, int columns, String title) {
        this(factory, attributeToEdit, rows, columns, title, null);
    }

    /** Create a annotation text editor for the specified attribute.
     *  @param factory The factory that created this editor.
     *  @param attributeToEdit The string attribute to edit.
     *  @param rows The number of rows.
     *  @param columns The number of columns.
     *  @param title The window title to use.
     *  @param document The document to use.  If the value is null,
     *  the the text from the attribute.
     */
    public TextEditorForStringAttributes(TextEditorFactory factory,
            Attribute attributeToEdit, int rows, int columns, String title,
            Document document) {
        super(title, document);
        _factory = factory;
        _attributeToEdit = attributeToEdit;
        if (document == null) {
            text.append(
                    TextEditorTableauFactory.getTextToEdit(_attributeToEdit));
        }
        text.setColumns(columns);
        text.setRows(rows);

        // The above will mark the text object modified. Reverse this.
        setModified(false);
    }

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

    /** Adjust the file menu so that only relevant items appear.
     *  This has to be called after pack().
     */
    @Override
    public void adjustFileMenu() {
        // Rename Save command.
        _fileMenuItems[3].setText("Apply");
        _fileMenuItems[3].setMnemonic(KeyEvent.VK_A);

        // Remove various menu item.
        // _fileMenu.remove(7);

        // _fileMenu.remove(6);
        // _fileMenu.remove(5);
        // _fileMenu.remove(4);
        // _fileMenu.remove(2);
        // _fileMenu.remove(1);
        // _fileMenu.remove(0);
    }

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

    /** Override to query whether to apply the changes, if any.
     *  @return False if the user cancels on a apply query.
     */
    @Override
    protected boolean _close() {
        // NOTE: The superclass doesn't do the right thing here,
        // since it requires an associated Tableau.
        // NOTE: We use dispose() here rather than just hiding the
        // window.  This ensures that derived classes can react to
        // windowClosed events rather than overriding the
        // windowClosing behavior given here.
        boolean returnValue = true;

        if (isModified()) {
            if (_queryForApply()) {
                // Avoid opening Python Actor, modifying the script,
                // clicking the x, being prompted for applying the
                // change, applying it, then closing the model and
                // *not* being prompted for save.
                if (_modelModified) {
                    setModified(true);
                }
                dispose();
            } else {
                return false;
            }
        } else {
            // Window is not modified, so just dispose.  This avoids this issue:
            // 1. $PTII/bin/vergil $PTII/ptolemy/actor/lib/python/demo/PythonScale/PythonScale.xml
            // 2. Look inside the PythonScript actor, change
            // self.output.broadcast(s.multiply(t))
            // to
            // self.output.broadcast(s.multiply(t).multiply(t))
            // 3. In the Python editor window, click on Save and then close
            // 4. In the model window, click on exit.
            // The user should be prompted for save.
            // 5. Rerun vergil, note that the change has not been saved.
            if (_modelModified) {
                setModified(true);
            }
            dispose();
        }

        // Ensure that a new editor is opened next time.
        this._factory.clear();

        return returnValue;
    }

    /** Override the base class to apply the change to the attribute.
     *  @return True if the save succeeded.
     */
    @Override
    protected boolean _save() {
        // Issue a change request to ensure the change is
        // applied at a safe time and that the model is marked
        // modified.
        NamedObj context = _attributeToEdit.getContainer();
        String request = "<property name=\"" + _attributeToEdit.getName()
                + "\" value=\""
                + StringUtilities.escapeForXML(_factory.getText()) + "\"/>";
        context.requestChange(new MoMLChangeRequest(this, context, request));
        setModified(false);
        _modelModified = true;
        return true;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private methods                   ////
    // Open a dialog to prompt the user to apply the data.
    // Return false if the user clicks "cancel", and otherwise return true.
    private boolean _queryForApply() {
        Object[] options = { "Apply", "Discard changes", "Cancel" };
        String query = "Apply changes to " + _attributeToEdit.getFullName()
                + "?";

        // Show the MODAL dialog
        int selected = JOptionPane.showOptionDialog(this, query,
                "Apply Changes?", JOptionPane.YES_NO_CANCEL_OPTION,
                JOptionPane.QUESTION_MESSAGE, null, options, options[0]);

        if (selected == 0) {
            return _save();
        } else if (selected == 1) {
            return true;
        }

        return false;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private members                   ////
    private final TextEditorFactory _factory;

    private Attribute _attributeToEdit;

    /** True if this attribute was modified and saved, which caused.
     *  the containing model to be modified.
     */
    private boolean _modelModified = false;
}