001: /*******************************************************************************
002: * Copyright (c) 2005, 2007 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.menus;
011:
012: import org.eclipse.core.expressions.IEvaluationContext;
013: import org.eclipse.jface.action.ContributionManager;
014: import org.eclipse.ui.services.IServiceWithSources;
015:
016: /**
017: * <p>
018: * Provides services related to the menu architecture within the workbench. It
019: * can be used to contribute additional items to the menu, tool bar and status
020: * line.
021: * </p>
022: * <p>
023: * This interface should not be implemented or extended by clients.
024: * </p>
025: *
026: * @since 3.3
027: */
028: public interface IMenuService extends IServiceWithSources {
029:
030: /**
031: * Contribute and initialize the contribution factory. This should only be
032: * called once per factory. After the call, the factory should be treated as
033: * an unmodifiable object.
034: * <p>
035: * <b>Note:</b> In 3.3M4, this will make the factory available for any
036: * following calls to
037: * {@link #populateContributionManager(ContributionManager, String)}, but
038: * it will not add those contributions to already populated managers.
039: * </p>
040: *
041: * @param factory
042: * the contribution factory. Must not be <code>null</code>
043: */
044: public void addContributionFactory(
045: AbstractContributionFactory factory);
046:
047: /**
048: * Remove the contributed factory from the menu service. If the factory is
049: * not contained by this service, this call does nothing.
050: * <p>
051: * <b>Note:</b>In 3.3M4, this factory will no longer be called during
052: * {@link #populateContributionManager(ContributionManager, String)} calls,
053: * but outstanding contributions will not be removed from populated
054: * contribution managers.
055: * </p>
056: *
057: * @param factory
058: * the contribution factory to remove. Must not be
059: * <code>null</code>.
060: */
061: public void removeContributionFactory(
062: AbstractContributionFactory factory);
063:
064: /**
065: * Populate a <code>ContributionManager</code> at the specified starting
066: * location with a set of <code>IContributionItems</code>s. It applies
067: * <code>AbstractContributionFactory</code>s that are stored against the
068: * provided location.
069: *
070: * @param mgr
071: * The ContributionManager to populate
072: * @param location
073: * The starting location to begin populating this contribution
074: * manager. The format is the Menu API URI format.
075: * @see #releaseContributions(ContributionManager)
076: */
077: public void populateContributionManager(ContributionManager mgr,
078: String location);
079:
080: /**
081: * Before calling dispose() on a ContributionManager populated by the menu
082: * service, you must inform the menu service to release its contributions.
083: * This takes care of unregistering any IContributionItems that have their
084: * visibleWhen clause managed by this menu service.
085: *
086: * @param mgr
087: * The manager that was populated by a call to
088: * {@link #populateContributionManager(ContributionManager, String)}
089: */
090: public void releaseContributions(ContributionManager mgr);
091:
092: /**
093: * Get the current state of eclipse as seen by the menu service.
094: *
095: * @return an IEvaluationContext containing state variables.
096: *
097: * @see org.eclipse.ui.ISources
098: */
099: public IEvaluationContext getCurrentState();
100: }
|