com.speedment.tool.actions.ProjectTreeComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tool-actions Show documentation

Actions that can be performed in the Speedment Tool.

There is a newer version: 3.2.10

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.tool.actions;

import com.speedment.runtime.config.trait.HasMainInterface;
import com.speedment.tool.config.DocumentProperty;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.MenuItem;
import javafx.scene.control.TreeCell;

import java.util.Optional;
import java.util.stream.Stream;

/**
 * Component that is responsible for creating the context menu that appears when
 * the user right-clicks any node in the Project Tree of the Speedment Tool.
 * Plugins can install their own context menus in this component.
 *
 * @author Emil Forslund
 * @since  3.0.17
 */
public interface ProjectTreeComponent {

    /**
     * Installs the specified menu builder for the specified node type.
     * This can be used to add additional options to the context menu
     * when the user right-clicks on various nodes in the Project Tree
     * section of the user interface.
     *
     * @param         the node type
     * @param nodeType     the node type to attach to items to
     * @param menuBuilder  menu builder for that type of node
     */
    
    void installContextMenu(Class nodeType,
                            ContextMenuBuilder menuBuilder);

    /**
     * Creates a context menu and fills it with all the appropriate
     * menu items for the specified tree cell and document. This will
     * invoke any previously installed context menu builders.
     * 
     * If no menu items should be visible for the specified cell and
     * document, an empty {@code Optional} is returned.
     *
     * @param      the document type
     * @param treeCell  the tree cell
     * @param doc       the document
     * @return          the constructed context menu or empty
     */
     Optional
    createContextMenu(TreeCell treeCell, DOC doc);

    /**
     * Builder that can construct a Context Menu for a particular
     * tree cell and document.
     *
     * @param   the document type
     */
    @FunctionalInterface
    interface ContextMenuBuilder {
        Stream build(TreeCell tc, DOC doc);
    }
}