001/* An interface for listeners that are invoked when a menu item is created.
002
003@Copyright (c) 2008-2016 The Regents of the University of California.
004All rights reserved.
005
006Permission is hereby granted, without written agreement and without
007license or royalty fees, to use, copy, modify, and distribute this
008software and its documentation for any purpose, provided that the
009above copyright notice and the following two paragraphs appear in all
010copies of this software.
011
012IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
013FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
014ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
015THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
016SUCH DAMAGE.
017
018THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
019INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
021PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
022CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
023ENHANCEMENTS, OR MODIFICATIONS.
024
025                        PT_COPYRIGHT_VERSION_2
026                        COPYRIGHTENDKEY
027
028
029
030 */
031
032package ptolemy.vergil.toolbox;
033
034import javax.swing.JMenuItem;
035
036import diva.gui.toolbox.JContextMenu;
037import ptolemy.kernel.util.NamedObj;
038
039/**
040 An interface for listeners that are invoked when a menu item is created.
041
042 @author Thomas Huining Feng
043 @version $Id$
044 @since Ptolemy II 8.0
045 @see MenuActionFactory
046 @Pt.ProposedRating Red (tfeng)
047 @Pt.AcceptedRating Red (tfeng)
048 */
049public interface MenuItemListener {
050
051    /** The method to be invoked when a menu item is created, so that this
052     *  listener can modify the menu item if it needs to.
053     *
054     *  @param menu The menu context.
055     *  @param object The object for which the menu item is created.
056     *  @param menuItem The created menu item.
057     */
058    public void menuItemCreated(JContextMenu menu, NamedObj object,
059            JMenuItem menuItem);
060}