KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > navigator > ICommonActionExtensionSite


1 /*******************************************************************************
2  * Copyright (c) 2005, 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.navigator;
12
13 import org.eclipse.jface.viewers.StructuredViewer;
14
15 /**
16  *
17  * Provides access to information required for the initialization of
18  * CommonActionProviders.
19  *
20  * <p>
21  * See the documentation of the <b>org.eclipse.ui.navigator.navigatorContent</b>
22  * extension point and {@link CommonActionProvider} for more information on
23  * contributing actions.
24  * </p>
25  *
26  * <p>
27  * This interface is not intended to be implemented by clients.
28  * </p>
29  *
30  * @see CommonActionProvider
31  *
32  * @since 3.2
33  */
34 public interface ICommonActionExtensionSite {
35
36     /**
37      * By default, the extension state model returned is for the associated
38      * content extension (if this is NOT a top-level action provider).
39      * Otherwise, clients may use
40      * {@link INavigatorContentService#findStateModel(String)} to locate the
41      * state model of another content extension.
42      *
43      * @return The extension state model of the associated Content Extension (if
44      * any) or a state model specifically for this
45      * ICommonActionProvider.
46      * @see IExtensionStateModel
47      */
48     IExtensionStateModel getExtensionStateModel();
49
50     /**
51      *
52      * @return The unique identifier of the associated content extension or the
53      * top-level Common Action Provider.
54      */
55     String JavaDoc getExtensionId();
56
57     /**
58      *
59      * @return The associated content service for the instantiated Common Action
60      * Provider.
61      */
62     INavigatorContentService getContentService();
63
64     /**
65      *
66      * @return The associated structured viewer for the instantiated Common
67      * Action Provider.
68      */
69     StructuredViewer getStructuredViewer();
70
71     /**
72      *
73      * @return The ICommonViewerSite from the CommonViewer.
74      */
75     ICommonViewerSite getViewSite();
76 }
77
Popular Tags