bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/EditorMenuManager.java

/*******************************************************************************
 * Copyright (c) 2000, 2017 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal;

import java.util.ArrayList;
import java.util.HashSet;
import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.IContributionManagerOverrides;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.SubMenuManager;
import org.eclipse.ui.actions.RetargetAction;

/**
 * An <code>EditorMenuManager</code> is used to sort the contributions made by
 * an editor so that they always appear after the action sets.
 */
public class EditorMenuManager extends SubMenuManager {
	private ArrayList<EditorMenuManager> wrappers;

	private boolean enabledAllowed = true;

	private class Overrides implements IContributionManagerOverrides {
		/**
		 * Indicates that the items of this manager are allowed to enable;
		 * <code>true</code> by default.
		 */
		public void updateEnabledAllowed() {
			// update the items in the map
			for (IContributionItem item : EditorMenuManager.super.getItems()) {
				item.update(IContributionManagerOverrides.P_ENABLED);
			}
			// update the wrapped menus
			if (wrappers != null) {
				for (EditorMenuManager manager : wrappers) {
					manager.setEnabledAllowed(enabledAllowed);
				}
			}
		}

		@Override
		public Boolean getEnabled(IContributionItem item) {
			if (((item instanceof ActionContributionItem)
					&& (((ActionContributionItem) item).getAction() instanceof RetargetAction)) || enabledAllowed) {
				return null;
			}
			return Boolean.FALSE;
		}

		@Override
		public Integer getAccelerator(IContributionItem item) {
			if (getEnabled(item) == null) {
				return getParentMenuManager().getOverrides().getAccelerator(item);
			}
			// no acclerator if the item is disabled
			return Integer.valueOf(0);
		}

		@Override
		public String getAcceleratorText(IContributionItem item) {
			return getParentMenuManager().getOverrides().getAcceleratorText(item);
		}

		@Override
		public String getText(IContributionItem item) {
			return getParentMenuManager().getOverrides().getText(item);
		}

		@Override
		public Boolean getVisible(IContributionItem item) {
			return getParentMenuManager().getOverrides().getVisible(item);
		}
	}

	private Overrides overrides = new Overrides();

	/**
	 * Constructs a new editor manager.
	 */
	public EditorMenuManager(IMenuManager mgr) {
		super(mgr);
	}

	@Override
	public IContributionItem[] getItems() {
		return getParentMenuManager().getItems();
	}

	@Override
	public IContributionManagerOverrides getOverrides() {
		return overrides;
	}

	/*
	 * Inserts the new item after any action set contributions which may exist
	 * within the toolbar to ensure a consistent order for actions.
	 */
	@Override
	public void prependToGroup(String groupName, IContributionItem item) {
		insertAfter(groupName, item);
	}

	@Override
	public void appendToGroup(String groupName, IContributionItem item) {
		try {
			// FIXME: this is killing at least SSE editors, see bug 318034
			super.appendToGroup(groupName, item);
		} catch (RuntimeException e) {
			WorkbenchPlugin.log(e);
		}
	}

	/**
	 * Sets the visibility of the manager. If the visibility is <code>true</code>
	 * then each item within the manager appears within the parent manager.
	 * Otherwise, the items are not visible.
	 * <p>
	 * If force visibility is <code>true</code>, or grayed out if force visibility
	 * is <code>false</code>
	 * <p>
	 * This is a workaround for the layout flashing when editors contribute large
	 * amounts of items.
	 * </p>
	 *
	 * @param visible         the new visibility
	 * @param forceVisibility whether to change the visibility or just the
	 *                        enablement state.
	 */
	public void setVisible(boolean visible, boolean forceVisibility) {
		if (visible) {
			if (forceVisibility) {
				// Make the items visible
				if (!enabledAllowed) {
					setEnabledAllowed(true);
				}
			} else {
				if (enabledAllowed) {
					setEnabledAllowed(false);
				}
			}
			if (!isVisible()) {
				setVisible(true);
			}
		} else if (forceVisibility) {
			// Remove the editor menu items
			setVisible(false);
		} else {
			// Disable the editor menu items.
			setEnabledAllowed(false);
		}
	}

	/**
	 * Sets the enablement ability of all the items contributed by the editor.
	 *
	 * @param enabledAllowed <code>true</code> if the items may enable
	 * @since 2.0
	 */
	public void setEnabledAllowed(boolean enabledAllowed) {
		if (this.enabledAllowed == enabledAllowed) {
			return;
		}
		this.enabledAllowed = enabledAllowed;
		overrides.updateEnabledAllowed();
	}

	@Override
	protected SubMenuManager wrapMenu(IMenuManager menu) {
		if (wrappers == null) {
			wrappers = new ArrayList<>();
		}
		EditorMenuManager manager = new EditorMenuManager(menu);
		wrappers.add(manager);
		return manager;
	}

	protected IAction[] getAllContributedActions() {
		HashSet<IAction> set = new HashSet<>();
		getAllContributedActions(set);
		return set.toArray(new IAction[set.size()]);
	}

	protected void getAllContributedActions(HashSet<IAction> set) {
		for (IContributionItem item : super.getItems()) {
			getAllContributedActions(set, item);
		}
		if (wrappers == null) {
			return;
		}
		for (EditorMenuManager element : wrappers) {
			element.getAllContributedActions(set);
		}
	}

	protected void getAllContributedActions(HashSet<IAction> set, IContributionItem item) {
		if (item instanceof MenuManager) {
			for (IContributionItem subItem : ((MenuManager) item).getItems()) {
				getAllContributedActions(set, subItem);
			}
		} else if (item instanceof ActionContributionItem) {
			set.add(((ActionContributionItem) item).getAction());
		}
	}
}