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