eu.mihosoft.vrl.visual.ActionDelegator Maven / Gradle / Ivy

Go to download
/* 
 * ActionDelelator.java
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007–2018 by Michael Hoffer,
 * Copyright (c) 2015–2018 G-CSC, Uni Frankfurt,
 * Copyright (c) 2009–2015 Steinbeis Forschungszentrum (STZ Ölbronn)
 * 
 * This file is part of Visual Reflection Library (VRL).
 *
 * VRL is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 * 
 * see: http://opensource.org/licenses/LGPL-3.0
 *      file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
 *
 * VRL is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * This version of VRL includes copyright notice and attribution requirements.
 * According to the LGPL this information must be displayed even if you modify
 * the source code of VRL. Neither the VRL Canvas attribution icon nor any
 * copyright statement/attribution may be removed.
 *
 * Attribution Requirements:
 *
 * If you create derived work you must do three things regarding copyright
 * notice and author attribution.
 *
 * First, the following text must be displayed on the Canvas:
 * "based on VRL source code". In this case the VRL canvas icon must be removed.
 * 
 * Second, the copyright notice must remain. It must be reproduced in any
 * program that uses VRL.
 *
 * Third, add an additional notice, stating that you modified VRL. A suitable
 * notice might read
 * "VRL source code modified by YourName 2012".
 * 
 * Note, that these requirements are in full accordance with the LGPL v3
 * (see 7. Additional Terms, b).
 *
 * Please cite the publication(s) listed below.
 *
 * Publications:
 *
 * M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
 * a framework for declarative GUI programming on the Java platform.
 * Computing and Visualization in Science, 2013, 16(4),
 * 181–192. http://doi.org/10.1007/s00791-014-0230-y
 */

package eu.mihosoft.vrl.visual;

/**
 * Delegates actions to the correct menu controllers.
 *
 * @author Michael Hoffer 
 */
public interface ActionDelegator {

    /**
     * Adds an action to this delegator.
     *
     * @param a action to add
     * @param destination destination
     * @return
     * true if the action could be added at the specified location;
     * false otherwise
     */
    public boolean addAction(Action a, String destination);

//    /**
//     * Adds an action to this delegator.
//     *
//     * @param a action to add
//     * @param destination destination
//     * @return
//     * true if the action could be added at the specified location;
//     * false otherwise
//     */
//    public boolean addAction(ActionGroup a, String destination);

    /**
     * Adds a separator to this delegator.
     *
     * @param destination destination
     * @return
     * true if the separator could be added at the specified
     * location;
     * false otherwise
     */
    public boolean addSeparator(String destination);
    /**
     * Popup menu of the canvas.
     */
    public final String CANVAS_MENU = "Action:Destination=CanvasMenu";
    /**
     * Window popup menu.
     */
    public final String WINDOW_MENU = "Action:Destination=WindowMenu";
    /**
     * File menu.
     */
    public final String FILE_MENU = "Action:Destination=FileMenu";
    /**
     * Edit menu.
     */
    public final String EDIT_MENU = "Action:Destination=EditMenu";
    /**
     * View menu.
     */
    public final String VIEW_MENU = "Action:Destination=ViewMenu";
    /**
     * Tool menu.
     */
    public final String TOOL_MENU = "Action:Destination=ToolMenu";
    /**
     * Debug menu.
     */
    public final String DEBUG_MENU = "Action:Destination=DebugMenu";
    /**
     * Info menu.
     */
    public final String INFO_MENU = "Action:Destination=InfoMenu";
}