alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Id: PluggableMenu.java,v 1.9 2004/02/29 12:35:39 linus Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// 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 OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.application.api;
import javax.swing.*;

/**
 * An interface which identifies an ArgoUML plug-in to the menu.
 * Plug-ins are replacements or additions to standard Argo classes.
 *   
 * PluggableMenu require two criteria.  The first is a JMenuItem.  The
 * second is an unlocalized string which identifies the menu
 * requesting the plugin, such as "File" or "Edit".
 *
 * @author Thierry Lach
 * @since 0.9.4
 */
public interface PluggableMenu extends Pluggable {

    /* NOTE: Don't make the KEY_ strings final since the string
       gets optimized into referring source code at compile time then.
       We DO want to use THIS instance of the string in case we want to
       change it in the future.
     */

    /** Key looked for in ProjectBrowser for File Import submenu.
     */
    public static String KEY_FILE_IMPORT = "File:Import";

    /** Key looked for in ProjectBrowser for View menu.
     */
    public static String KEY_VIEW = "View";

    /** Key looked for in ProjectBrowser for Create Diagram menu.
     */
    public static String KEY_CREATE_DIAGRAMS = "Create Diagrams";

    /** Key looked for in ProjectBrowser for Arrange menu.
     */
    public static String KEY_ARRANGE = "Arrange";

    /** Key looked for in ProjectBrowser for Generate menu.
     */
    public static String KEY_GENERATE = "Generate";

    /** Key looked for in ProjectBrowser for Tools menu.
     */
    public static String KEY_TOOLS = "Tools";

    /** Key looked for in ProjectBrowser for Help menu.
     */
    public static String KEY_HELP = "Help";


    /**
     * Return the JMenuItem controlled by the plugin under the
     * specific context.  One menu plugin may control multiple menu
     * items.
     *
     * @param context array of objects
     *            as created by {@link #buildContext(JMenuItem, String) }.
     *
     * @return A JMenuItem object controlled by the plug-in.
     *
     * @since ARGO0.11.3
     * @author Thierry Lach
     */
    public JMenuItem getMenuItem(Object[] context);

    /**
     * Helper to create a context recognized by
     * {@link org.argouml.application.api.Pluggable#inContext(Object[])}.
     *
     * @param parentMenuItem menu item
     * @param menuType menu name
     * @return the proper context array.
     */
    public Object[] buildContext(JMenuItem parentMenuItem, String menuType);

} /* End interface PluggableMenu */

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.