/*******************************************************************************
 * Copyright (c) 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.action;

import org.eclipse.jface.util.Assert;

/**
 * A <code>SubCoolBarManager</code> 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 
	 *      <code>SubCoolBarManager</code> are forwarded and appear in the
	 *      parent manager.
	 */
	public SubCoolBarManager(ICoolBarManager mgr) {
		super(mgr);
		Assert.isNotNull(mgr);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.ICoolBarManager#add(org.eclipse.jface.action.IToolBarManager)
	 */
	public void add(IToolBarManager toolBarManager) {
		Assert.isNotNull(toolBarManager);
		super.add(new ToolBarContributionItem(toolBarManager));
	}

	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.ICoolBarManager#getStyle()
	 */
	public int getStyle() {
		// It is okay to cast down since we only accept coolBarManager objects in the
		// constructor
		return ((CoolBarManager)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();
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.ICoolBarManager#isLayoutLocked()
	 */
	public boolean getLockLayout() {
		return getParentCoolBarManager().getLockLayout();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.ICoolBarManager#lockLayout(boolean)
	 */
	public void setLockLayout(boolean value) {}

	/* (non-Javadoc)
	 * SubCoolBarManagers do not have control of the global context menu.
	 */
	public IMenuManager getContextMenuManager() {
		return null;
	}

	/* (non-Javadoc)
	 * In SubCoolBarManager we do nothing.
	 */
	public void setContextMenuManager(IMenuManager menuManager) {
		// do nothing
	}

	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.IContributionManager#update(boolean)
	 */
	public void update(boolean force) {
		// This method is not governed by visibility.  The client may
		// call <code>setVisible</code> and then force an update.  At that
		// point we need to update the parent.
		getParentCoolBarManager().update(force);
	}

}