org.eclipse.jface.action.SubCoolBarManager 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
JFace
The newest version!
/*******************************************************************************
 * Copyright (c) 2003, 2015 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.jface.action;

import org.eclipse.core.runtime.Assert;

/**
 * A SubCoolBarManager monitors the additional and removal of
 * items from a parent manager so that visibility of the entire set can be changed as a
 * unit.
 *
 * @since 3.0
 */
public class SubCoolBarManager extends SubContributionManager implements
		ICoolBarManager {

	/**
	 * Constructs a new manager.
	 *
	 * @param mgr the parent manager.  All contributions made to the
	 *      SubCoolBarManager are forwarded and appear in the
	 *      parent manager.
	 */
	public SubCoolBarManager(ICoolBarManager mgr) {
		super(mgr);
		Assert.isNotNull(mgr);
	}

	@Override
	public void add(IToolBarManager toolBarManager) {
		Assert.isNotNull(toolBarManager);
		super.add(new ToolBarContributionItem(toolBarManager));
	}

	@Override
	public int getStyle() {
		// It is okay to cast down since we only accept coolBarManager objects in the
		// constructor
		return ((ICoolBarManager) getParent()).getStyle();
	}

	/**
	 * Returns the parent cool bar manager that this sub-manager contributes to.
	 *
	 * @return the parent cool bar manager
	 */
	protected final ICoolBarManager getParentCoolBarManager() {
		// Cast is ok because that's the only
		// thing we accept in the construtor.
		return (ICoolBarManager) getParent();
	}

	@Override
	public boolean getLockLayout() {
		return getParentCoolBarManager().getLockLayout();
	}

	@Override
	public void setLockLayout(boolean value) {
	}

	@Override
	public IMenuManager getContextMenuManager() {
		return null;
	}

	@Override
	public void setContextMenuManager(IMenuManager menuManager) {
		// do nothing
	}

	@Override
	public void update(boolean force) {
		// This method is not governed by visibility.  The client may
		// call setVisible and then force an update.  At that
		// point we need to update the parent.
		getParentCoolBarManager().update(force);
	}

}