blob: fbedb82748fd93476fc6eca140ab80836cc00269 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved.
*/
package org.eclipse.search.ui;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.dialogs.SelectionDialog;
import org.eclipse.search.internal.ui.SearchPlugin;
import org.eclipse.search.internal.ui.SearchPluginImages;
import org.eclipse.search.internal.workingsets.WorkingSet;
import org.eclipse.search.internal.workingsets.WorkingSetSelectionDialog;
/**
* The central class for access to the Search Plug-in's User Interface.
* This class cannot be instantiated; all functionality is provided by
* static methods.
*
* Features provided:
* <ul>
* <li>convenient access to the search result view of the active workbench
* window.</li>
* </ul>
*
* @see ISearchResultView
*/
public final class SearchUI {
/**
* Search Plug-in Id (value <code>"org.eclipse.search"</code>).
*/
public static final String PLUGIN_ID= "org.eclipse.search"; //$NON-NLS-1$
/**
* Search marker type (value <code>"org.eclipse.search.searchmarker"</code>).
*
* @see org.eclipse.core.resources.IMarker
*/
public static final String SEARCH_MARKER= PLUGIN_ID + ".searchmarker"; //$NON-NLS-1$
/**
* Line marker attribute (value <code>"line"</code>)
* The value of the marker attribute is the line which contains the text search match.
*
* @see org.eclipse.core.resources.IMarker#getAttribute
*/
public static final String LINE= "line"; //$NON-NLS-1$
/**
* Id of the Search result view
* (value <code>"org.eclipse.search.SearchResultView"</code>).
*/
public static final String SEARCH_RESULT_VIEW_ID= PLUGIN_ID + ".SearchResultView"; //$NON-NLS-1$
/**
* Id of the Search action set
* (value <code>"org.eclipse.search.searchActionSet"</code>).
*/
public static final String ACTION_SET_ID= PLUGIN_ID + ".searchActionSet"; //$NON-NLS-1$
/**
* Activates the search result view in the active page of the
* active workbench window. This call has no effect (but returns <code>true</code>
* if the search result view is already activated.
*
* @return <code>true</code> if the search result view could be activated
*/
public static boolean activateSearchResultView() {
return SearchPlugin.activateSearchResultView();
}
/**
* Returns the search result view of the active page of the
* active workbench window.
*
* @return the search result view or <code>null</code>
* if there is no active search result view
*/
public static ISearchResultView getSearchResultView() {
return SearchPlugin.getSearchResultView();
}
/**
* Returns the shared search marker image.
* Normally, editors show this icon in their vertical ruler.
* This image is owned by the search UI plug-in and must not be disposed
* by clients.
*
* @return the shared image
*/
public static Image getSearchMarkerImage() {
return SearchPluginImages.get(SearchPluginImages.IMG_OBJ_SEARCHMARKER);
}
/**
* Creates a selection dialog that lists all working sets and allows to
* add and edit working sets.
* The caller is responsible for opening the dialog with <code>Window.open</code>,
* and subsequently extracting the selected working sets (of type
* <code>IWorkingSet</code>) via <code>SelectionDialog.getResult</code>.
* <p>
* This method is for internal use only due to issue below. Once
* the issues is solved there will be an official API.
* </p>
* <p>
* [Issue: Working set must be provided by platform.]
* </p>
*
* @param parent the parent shell of the dialog to be created
* @return a new selection dialog or <code>null</code> if none available
*/
public static SelectionDialog createWorkingSetDialog(Shell parent) {
return new WorkingSetSelectionDialog(parent);
}
/**
* Returns all working sets for the workspace.
*
* This method is for internal use only due to issue below. Once
* the issues is solved there will be an official API.
* </p>
* <p>
* [Issue: Working set must be provided by platform.]
* </p>
*
* @return an array of IWorkingSet
*/
public static IWorkingSet[] getWorkingSets() {
return WorkingSet.getWorkingSets();
}
/**
a working set by name.
*
* This method is for internal use only due to issue below. Once
* the issues is solved there will be an official API.
* </p>
* <p>
* [Issue: Working set must be provided by platform.]
* </p>
*
* @param name the name the working set
* @return the working set with the given name or <code>null</code> if not found
*/
public static IWorkingSet findWorkingSet(String name) {
return WorkingSet.find(name);
}
/**
* Block instantiation.
*/
private SearchUI() {
}
}
|
