KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > intro > IIntroSite


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