/* An event notifying about changes in the visual content.

Copyright (c) 2000-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.homer.events;

import java.awt.event.ActionEvent;

import ptolemy.homer.kernel.PositionableElement;

///////////////////////////////////////////////////////////////////
//// VisualContentEvent

/** An event notifying about changes in the visual content.
 *
 *  @author Peter Foldes
 *  @version $Id: VisualContentEvent.java 69607 2014-07-30 17:07:26Z cxh $
 *  @since Ptolemy II 10.0
 *  @Pt.ProposedRating Red (pdf)
 *  @Pt.AcceptedRating Red (pdf)
 */
@SuppressWarnings("serial")
public class VisualContentEvent extends ActionEvent {

    ///////////////////////////////////////////////////////////////////
    ////                         constructor                       ////

    /** Create a new instance of the visual content event.
     *  @param source The source of the event.
     *  @param id The id of the event.
     *  @param command The command of the event.
     *  @param element The affected element.
     */
    public VisualContentEvent(Object source, int id, String command,
            PositionableElement element) {
        super(source, id, command);
        _element = element;
    }

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

    /** Get the affected positionable element.
     *  @return The affected positionable element.
     */
    public PositionableElement getElement() {
        return _element;
    }

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

    /** The affected positionable element.
     */
    private PositionableElement _element;
}