/* Display the evolution of a Petri net.

 Copyright (c) 2010-2014 The University of Florida

 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 FLORIDA 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 FLORIDA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF FLORIDA 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
 FLORIDA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

  PT_COPYRIGHT_VERSION_2
  COPYRIGHTENDKEY

 */

package ptolemy.domains.petrinet.lib.gui;

import javax.swing.JTextArea;

import ptolemy.actor.lib.gui.Display;
import ptolemy.domains.petrinet.kernel.PetriNetDisplayer;
import ptolemy.gui.Top;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;

/**
   Display the evolution of a Petri net after execution.

   <p>Place this actor on a canvas along with a Petri Net (containing
   Places and Transitions) and the actor will display the evolution of
   the Net after execution. Specifically, the token count of each
   place will be printed for each iteration.</p>

   <p>It should be noted that there are alignment issues within the display
   on certain operating systems where the font used is not monospaced.</p>

   @author  Zach Ezzell
   @version $Id: PetriNetDisplay.java 69607 2014-07-30 17:07:26Z cxh $
   @since Ptolemy II 10.0
   @Pt.ProposedRating Red (yukewang)
   @Pt.AcceptedRating Red (reviewmoderator)
 */
public class PetriNetDisplay extends Display implements PetriNetDisplayer {

    /**
     * Construct a new PetriNetDisplay.
     *
     * @param container
     *           The CompositeEntity.
     * @param name
     *            The name of the PetriNetDisplay.
     *
     * @exception IllegalActionException
     *                If the name has a period in it.
     *
     * @exception NameDuplicationException
     *                If the container already contains an entity with
     *                the specified name.
     */

    public PetriNetDisplay(CompositeEntity container, String name)
            throws IllegalActionException, NameDuplicationException {
        super(container, name);
        text = "";
    }

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

    /** Ensure that the text is placed in the textArea.
     *
     * @exception IllegalActionException If _openWindow() in the base
     * class throws it.
     */
    @Override
    public void openDisplay() throws IllegalActionException {
        if (!_initialized) {
            _initialized = true;
            _openWindow();
            if (_debugging) {
                _debug("Called openWindow()");

            }
        }
        // Set the text area in the Swing Event Thread or risk getting a NPE.
        Runnable doIt = new Runnable() {
            @Override
            public void run() {
                JTextArea textArea = (JTextArea) _getImplementation()
                        .getTextArea();
                textArea.setText(text);
                if (_debugging) {
                    _debug("Called setText(" + text + ")");
                }
            }
        };
        Top.deferIfNecessary(doIt);
    }

    /** Set the text for the display.  This method is called by the
     * PetriNetDirector.
     *
     * @param text
     *          The text to be shown in the display.
     */
    @Override
    public void setText(String text) {
        if (_debugging) {
            _debug("text: " + text);
        }
        this.text = text;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////

    /** This string represents the evolution of the Petri Net and should
     * be set by the PetriNetDirector.
     */
    String text;

}