org.eclipse.jface.action.IMenuManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface Show documentation
This is org.eclipse.jface jar used by Scout SDK
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2015 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.action;

/**
 * The IMenuManager interface provides protocol for managing
 * contributions to a menu bar and its sub menus.
 * An IMenuManager is also an IContributionItem,
 * allowing sub-menus to be nested in parent menus.
 * 
 * This interface is internal to the framework; it should not be implemented outside
 * the framework.
 * 
 * 
 * This package provides a concrete menu manager implementation,
 * {@link MenuManager MenuManager}.
 * 
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IMenuManager extends IContributionManager, IContributionItem {
    /**
     * Adds a menu listener to this menu.
     * Has no effect if an identical listener is already registered.
     *
     * @param listener a menu listener
     */
    public void addMenuListener(IMenuListener listener);

    /**
     * Finds the manager for the menu at the given path. A path
     * consists of contribution item ids separated by the separator
     * character.  The path separator character is '/'.
     * 
     * Convenience for findUsingPath(path) which
     * extracts an IMenuManager if possible.
     * 
     *
     * @param path the path string
     * @return the menu contribution item, or null
     *   if there is no such contribution item or if the item does
     *   not have an associated menu manager
     */
    public IMenuManager findMenuUsingPath(String path);

    /**
     * Finds the contribution item at the given path. A path
     * consists of contribution item ids separated by the separator
     * character. The path separator character is '/'.
     *
     * @param path the path string
     * @return the contribution item, or null if there is no
     *   such contribution item
     */
    public IContributionItem findUsingPath(String path);

    /**
	 * Returns whether all items should be removed when the menu is about to
	 * show, but before notifying menu listeners. The default is
	 * false.
	 *
	 * @return true if all items should be removed when shown,
	 *         false if not
	 */
    public boolean getRemoveAllWhenShown();

    /**
     * Returns whether this menu should be enabled or not.
     *
     * @return true if enabled, and
     *   false if disabled
     */
    @Override
	public boolean isEnabled();

    /**
     * Removes the given menu listener from this menu.
     * Has no effect if an identical listener is not registered.
     *
     * @param listener the menu listener
     */
    public void removeMenuListener(IMenuListener listener);

    /**
	 * Sets whether all items should be removed when the menu is about to show,
	 * but before notifying menu listeners.
	 *
	 * @param removeAll
	 *            true if all items should be removed when shown,
	 *            false if not
	 */
    public void setRemoveAllWhenShown(boolean removeAll);

    /**
     * Incrementally builds the menu from the contribution items, and
     * does so recursively for all submenus.
     *
     * @param force true means update even if not dirty,
     *   and false for normal incremental updating
     */
    public void updateAll(boolean force);
}