|
1
|
/*******************************************************************************
|
|
2
|
* Copyright (c) 2005, 2009 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
|
* @see CommonActionProvider
|
|
27
|
* @noextend This interface is not intended to be extended by clients.
|
|
28
|
* @noimplement This interface is not intended to be implemented by clients.
|
|
29
|
*
|
|
30
|
* @since 3.2
|
|
31
|
*/
|
|
32
|
public interface ICommonActionExtensionSite {
|
|
33
|
|
|
34
|
/**
|
|
35
|
* By default, the extension state model returned is for the associated
|
|
36
|
* content extension (if this is NOT a top-level action provider).
|
|
37
|
* Otherwise, clients may use
|
|
38
|
* {@link INavigatorContentService#findStateModel(String)} to locate the
|
|
39
|
* state model of another content extension.
|
|
40
|
*
|
|
41
|
* @return The extension state model of the associated Content Extension (if
|
|
42
|
* any) or a state model specifically for this
|
|
43
|
* ICommonActionProvider.
|
|
44
|
* @see IExtensionStateModel
|
|
45
|
*/
|
|
46
|
IExtensionStateModel getExtensionStateModel();
|
|
47
|
|
|
48
|
/**
|
|
49
|
*
|
|
50
|
* @return The unique identifier of the associated content extension or the
|
|
51
|
* top-level Common Action Provider.
|
|
52
|
*/
|
|
53
|
String getExtensionId();
|
|
54
|
|
|
55
|
/**
|
|
56
|
*
|
|
57
|
* @return The id of the associated plugin for the Common Action Provider.
|
|
58
|
* @since 3.4
|
|
59
|
*/
|
|
60
|
String getPluginId();
|
|
61
|
|
|
62
|
/**
|
|
63
|
*
|
|
64
|
* @return The associated content service for the instantiated Common Action
|
|
65
|
* Provider.
|
|
66
|
*/
|
|
67
|
INavigatorContentService getContentService();
|
|
68
|
|
|
69
|
/**
|
|
70
|
*
|
|
71
|
* @return The associated structured viewer for the instantiated Common
|
|
72
|
* Action Provider.
|
|
73
|
*/
|
|
74
|
StructuredViewer getStructuredViewer();
|
|
75
|
|
|
76
|
/**
|
|
77
|
*
|
|
78
|
* @return The ICommonViewerSite from the CommonViewer.
|
|
79
|
*/
|
|
80
|
ICommonViewerSite getViewSite();
|
|
81
|
}
|