/******************************************************************************* * Copyright (c) 2000, 2008 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.ui; import org.eclipse.ui.services.IServiceLocator; /** *
* A service that is capable of nesting other services within itself. This * allows lower level components to query for a service provider in a * hierarchical fashion, and for information to be resolved in a hierarchical * manner *
** This interface is not intended to be implemented or extended by clients. *
* * @since 2.1.3 * @deprecated This is now handled by {@link IServiceLocator} which can * be nested. * @noimplement This interface is not intended to be implemented by clients. */ public interface INestableKeyBindingService extends IKeyBindingService { /** * Marks the service associated withnestedSite
as active if
* one exists. If there is no service associated, then nothing changes.
* Calling this method with null
forces deactivation of the
* current service.
*
* @param nestedSite The site whose service should be activated;
* null
if the current service should be deactivated.
* @return true
if a service is activated (or deactivated, in
* the case of a null
parameter); false
if
* nothing changed.
*/
public boolean activateKeyBindingService(IWorkbenchSite nestedSite);
/**
* An accessor for the nested key binding service associated with a
* particular site. If the key binding service does not exist for this
* nestedSite
already, then a new one should be constructed.
*
* @param nestedSite The site for which the service should be found;
* should not be null
.
* @return The associated service, if any; or a new associated service, if
* none existed previously.
*/
public IKeyBindingService getKeyBindingService(IWorkbenchSite nestedSite);
/**
* Removes a nested key binding service from this key binding service. The
* service to remove is determined by the nestedSite
with
* which it is associated.
*
* @param nestedSite The site from which to remove the nested service.
* This site must not be null
.
* @return true
if the service existed and could be removed;
* false
otherwise.
*/
public boolean removeKeyBindingService(IWorkbenchSite nestedSite);
}