01: /*******************************************************************************
02: * Copyright (c) 2004, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.intro;
11:
12: import org.eclipse.ui.IActionBars;
13: import org.eclipse.ui.IKeyBindingService;
14: import org.eclipse.ui.IWorkbenchSite;
15:
16: /**
17: * The primary interface between an intro part and the workbench.
18: * <p>
19: * The workbench exposes its implemention of intro part sites via this
20: * interface, which is not intended to be implemented or extended by clients.
21: * </p>
22: *
23: * @since 3.0
24: */
25: public interface IIntroSite extends IWorkbenchSite {
26:
27: /**
28: * Returns the part registry extension id for this intro site's part.
29: * <p>
30: * The name comes from the <code>id</code> attribute in the configuration
31: * element.
32: * </p>
33: *
34: * @return the registry extension id
35: */
36: public String getId();
37:
38: /**
39: * Returns the unique identifier of the plug-in that defines this intro
40: * site's part.
41: *
42: * @return the unique identifier of the declaring plug-in
43: * @see org.eclipse.core.runtime.IPluginDescriptor#getUniqueIdentifier()
44: */
45: public String getPluginId();
46:
47: /**
48: * Returns the key binding service in use.
49: * <p>
50: * The part will access this service to register
51: * all of its actions, to set the active scope.
52: * </p>
53: *
54: * @return the key binding service in use
55: * @deprecated Use IServiceLocator#getService(*) to retrieve
56: * IContextService and IHandlerService instead.
57: */
58: public IKeyBindingService getKeyBindingService();
59:
60: /**
61: * Returns the action bars for this part site.
62: * The intro part has exclusive use of its site's action bars.
63: *
64: * @return the action bars
65: */
66: public IActionBars getActionBars();
67: }
|