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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.search.internal.ui;
import java.util.Arrays;
import java.util.Comparator;
import com.ibm.icu.text.Collator;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.ColorFieldEditor;
import org.eclipse.jface.preference.ComboFieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferenceConverter;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.ui.IPerspectiveDescriptor;
import org.eclipse.ui.IPerspectiveRegistry;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.PlatformUI;
import org.eclipse.search.internal.core.text.TextSearchEngineRegistry;
/*
* The page for setting the Search preferences.
*/
public class SearchPreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
public static final String PAGE_ID= "org.eclipse.search.preferences.SearchPreferencePage"; //$NON-NLS-1$
public static final String IGNORE_POTENTIAL_MATCHES= "org.eclipse.search.potentialMatch.ignore"; //$NON-NLS-1$
public static final String EMPHASIZE_POTENTIAL_MATCHES= "org.eclipse.search.potentialMatch.emphasize"; //$NON-NLS-1$
public static final String POTENTIAL_MATCH_FG_COLOR= "org.eclipse.search.potentialMatch.fgColor"; //$NON-NLS-1$
public static final String REUSE_EDITOR= "org.eclipse.search.reuseEditor"; //$NON-NLS-1$
public static final String DEFAULT_PERSPECTIVE= "org.eclipse.search.defaultPerspective"; //$NON-NLS-1$
private static final String NO_DEFAULT_PERSPECTIVE= "org.eclipse.search.defaultPerspective.none"; //$NON-NLS-1$
public static final String BRING_VIEW_TO_FRONT= "org.eclipse.search.bringToFront"; //$NON-NLS-1$
public static final String TEXT_SEARCH_ENGINE = "org.eclipse.search.textSearchEngine"; //$NON-NLS-1$
public static final String TEXT_SEARCH_QUERY_PROVIDER = "org.eclipse.search.textSearchQueryProvider"; //$NON-NLS-1$
public static final String LIMIT_HISTORY= "org.eclipse.search.limitHistory"; //$NON-NLS-1$
private ColorFieldEditor fColorEditor;
private BooleanFieldEditor fEmphasizedCheckbox;
private BooleanFieldEditor fIgnorePotentialMatchesCheckbox;
private static class PerspectiveDescriptorComparator implements Comparator<IPerspectiveDescriptor> {
@Override
public int compare(IPerspectiveDescriptor o1, IPerspectiveDescriptor o2) {
String id1= o1.getLabel();
String id2= o2.getLabel();
return Collator.getInstance().compare(id1, id2);
}
}
public SearchPreferencePage() {
super(GRID);
setPreferenceStore(SearchPlugin.getDefault().getPreferenceStore());
}
public static void initDefaults(IPreferenceStore store) {
RGB gray= new RGB(85, 85, 85);
store.setDefault(EMPHASIZE_POTENTIAL_MATCHES, true);
store.setDefault(IGNORE_POTENTIAL_MATCHES, false);
PreferenceConverter.setDefault(store, POTENTIAL_MATCH_FG_COLOR, gray);
store.setDefault(REUSE_EDITOR, true);
store.setDefault(BRING_VIEW_TO_FRONT, true);
store.setDefault(DEFAULT_PERSPECTIVE, NO_DEFAULT_PERSPECTIVE);
store.setDefault(TEXT_SEARCH_ENGINE, ""); //default search engine is empty string //$NON-NLS-1$
store.setDefault(TEXT_SEARCH_QUERY_PROVIDER, ""); // default query provider is empty string //$NON-NLS-1$
store.setDefault(LIMIT_HISTORY, 10);
}
@Override
public void createControl(Composite parent) {
super.createControl(parent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), ISearchHelpContextIds.SEARCH_PREFERENCE_PAGE);
}
@Override
protected void createFieldEditors() {
addField(new BooleanFieldEditor(REUSE_EDITOR, SearchMessages.SearchPreferencePage_reuseEditor, getFieldEditorParent()));
addField(new BooleanFieldEditor(BRING_VIEW_TO_FRONT, SearchMessages.SearchPreferencePage_bringToFront, getFieldEditorParent()));
fIgnorePotentialMatchesCheckbox= new BooleanFieldEditor(
IGNORE_POTENTIAL_MATCHES,
SearchMessages.SearchPreferencePage_ignorePotentialMatches,
getFieldEditorParent());
addField(fIgnorePotentialMatchesCheckbox);
fEmphasizedCheckbox= new BooleanFieldEditor(
EMPHASIZE_POTENTIAL_MATCHES,
SearchMessages.SearchPreferencePage_emphasizePotentialMatches,
getFieldEditorParent());
addField(fEmphasizedCheckbox);
fColorEditor= new ColorFieldEditor(
POTENTIAL_MATCH_FG_COLOR,
SearchMessages.SearchPreferencePage_potentialMatchFgColor,
getFieldEditorParent()
);
addField(fColorEditor);
fEmphasizedCheckbox.setEnabled(!arePotentialMatchesIgnored(), getFieldEditorParent());
fColorEditor.setEnabled(!arePotentialMatchesIgnored() && arePotentialMatchesEmphasized(), getFieldEditorParent());
handleDeletedPerspectives();
String[][] perspectiveNamesAndIds = getPerspectiveNamesAndIds();
ComboFieldEditor comboEditor= new ComboFieldEditor(
DEFAULT_PERSPECTIVE,
SearchMessages.SearchPreferencePage_defaultPerspective,
perspectiveNamesAndIds,
getFieldEditorParent());
addField(comboEditor);
// in case we have a contributed engine, let the user choose.
TextSearchEngineRegistry reg= SearchPlugin.getDefault().getTextSearchEngineRegistry();
String[][] engineNamesAndIds= reg.getAvailableEngines();
if (engineNamesAndIds.length > 1) {
comboEditor= new ComboFieldEditor(
TEXT_SEARCH_ENGINE,
SearchMessages.SearchPreferencePage_textSearchEngine,
engineNamesAndIds,
getFieldEditorParent());
addField(comboEditor);
}
}
@Override
public void setVisible(boolean state) {
handleDeletedPerspectives();
super.setVisible(state);
}
@Override
public void propertyChange(PropertyChangeEvent event) {
updateFieldEnablement();
}
@Override
public void init(IWorkbench workbench) {
}
@Override
protected void performDefaults() {
super.performDefaults();
updateFieldEnablement();
}
private void updateFieldEnablement() {
boolean arePotentialMatchesIgnored= fIgnorePotentialMatchesCheckbox.getBooleanValue();
fEmphasizedCheckbox.setEnabled(!arePotentialMatchesIgnored, getFieldEditorParent());
fColorEditor.setEnabled(!arePotentialMatchesIgnored && fEmphasizedCheckbox.getBooleanValue(), getFieldEditorParent());
}
/*
* Return a 2-dimensional array of perspective names and ids.
*/
private String[][] getPerspectiveNamesAndIds() {
IPerspectiveRegistry registry= PlatformUI.getWorkbench().getPerspectiveRegistry();
IPerspectiveDescriptor[] perspectiveDescriptors= registry.getPerspectives();
Arrays.sort(perspectiveDescriptors, new PerspectiveDescriptorComparator());
String[][] table = new String[perspectiveDescriptors.length + 1][2];
table[0][0] = SearchMessages.SearchPreferencePage_defaultPerspective_none;
table[0][1] = NO_DEFAULT_PERSPECTIVE;
for (int i = 0; i < perspectiveDescriptors.length; i++) {
table[i + 1][0] = perspectiveDescriptors[i].getLabel();
table[i + 1][1] = perspectiveDescriptors[i].getId();
}
return table;
}
private static void handleDeletedPerspectives() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
String id= store.getString(DEFAULT_PERSPECTIVE);
if (PlatformUI.getWorkbench().getPerspectiveRegistry().findPerspectiveWithId(id) == null) {
store.putValue(DEFAULT_PERSPECTIVE, NO_DEFAULT_PERSPECTIVE);
}
}
// Accessors to preference values
public static String getDefaultPerspectiveId() {
handleDeletedPerspectives();
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
String id= store.getString(DEFAULT_PERSPECTIVE);
if (id == null || id.isEmpty() || id.equals(NO_DEFAULT_PERSPECTIVE))
return null;
else if (PlatformUI.getWorkbench().getPerspectiveRegistry().findPerspectiveWithId(id) == null) {
store.putValue(DEFAULT_PERSPECTIVE, id);
return null;
}
return id;
}
public static boolean isEditorReused() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
return store.getBoolean(REUSE_EDITOR);
}
public static boolean isViewBroughtToFront() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
return store.getBoolean(BRING_VIEW_TO_FRONT);
}
public static boolean arePotentialMatchesIgnored() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
return store.getBoolean(IGNORE_POTENTIAL_MATCHES);
}
public static boolean arePotentialMatchesEmphasized() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
return store.getBoolean(EMPHASIZE_POTENTIAL_MATCHES);
}
public static RGB getPotentialMatchForegroundColor() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
return PreferenceConverter.getColor(store, POTENTIAL_MATCH_FG_COLOR);
}
public static int getHistoryLimit() {
IPreferenceStore store= SearchPlugin.getDefault().getPreferenceStore();
int limit= store.getInt(LIMIT_HISTORY);
if (limit < 1) {
limit= 1;
} else if (limit >= 100) {
limit= 99;
}
return limit;
}
}
|
