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
|
/*******************************************************************************
* Copyright (c) 2004, 2009 Tasktop Technologies and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Tasktop Technologies - initial API and implementation
* IBM Corporation - helper methods from
* org.eclipse.wst.common.frameworks.internal.ui.WTPActivityHelper
*******************************************************************************/
package org.eclipse.equinox.internal.p2.ui.discovery.util;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Calendar;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.equinox.internal.p2.core.helpers.LogHelper;
import org.eclipse.equinox.internal.p2.ui.discovery.DiscoveryUi;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IPluginContribution;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.activities.IIdentifier;
import org.eclipse.ui.activities.IWorkbenchActivitySupport;
import org.eclipse.ui.browser.IWebBrowser;
import org.eclipse.ui.browser.IWorkbenchBrowserSupport;
import org.eclipse.ui.internal.browser.WebBrowserPreference;
import org.eclipse.ui.internal.browser.WorkbenchBrowserSupport;
/**
* @author Mik Kersten
* @author Steffen Pingel
*/
public class WorkbenchUtil {
/**
* Return the modal shell that is currently open. If there isn't one then return null.
* <p>
* <b>Note: Applied from patch on bug 99472.</b>
*
* @param shell
* A shell to exclude from the search. May be <code>null</code>.
* @return Shell or <code>null</code>.
*/
private static Shell getModalShellExcluding(Shell shell) {
IWorkbench workbench = PlatformUI.getWorkbench();
Shell[] shells = workbench.getDisplay().getShells();
int modal = SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL | SWT.PRIMARY_MODAL;
for (Shell shell2 : shells) {
if (shell2.equals(shell)) {
break;
}
// Do not worry about shells that will not block the user.
if (shell2.isVisible()) {
int style = shell2.getStyle();
if ((style & modal) != 0) {
return shell2;
}
}
}
return null;
}
/**
* Utility method to get the best parenting possible for a dialog. If there is a modal shell create it so as to
* avoid two modal dialogs. If not then return the shell of the active workbench window. If neither can be found
* return null.
* <p>
* <b>Note: Applied from patch on bug 99472.</b>
*
* @return Shell or <code>null</code>
*/
public static Shell getShell() {
if (!PlatformUI.isWorkbenchRunning() || PlatformUI.getWorkbench().isClosing()) {
return null;
}
Shell modal = getModalShellExcluding(null);
if (modal != null) {
return modal;
}
return getNonModalShell();
}
/**
* Get the active non modal shell. If there isn't one return null.
* <p>
* <b>Note: Applied from patch on bug 99472.</b>
*
* @return Shell
*/
private static Shell getNonModalShell() {
IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
if (window == null) {
IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows();
if (windows.length > 0) {
return windows[0].getShell();
}
} else {
return window.getShell();
}
return null;
}
/**
* @return whether the UI is set up to filter contributions (has defined activity categories).
*/
public static final boolean isFiltering() {
return !PlatformUI.getWorkbench().getActivitySupport().getActivityManager().getDefinedActivityIds().isEmpty();
}
public static boolean allowUseOf(Object object) {
if (!isFiltering()) {
return true;
}
if (object instanceof IPluginContribution) {
IPluginContribution contribution = (IPluginContribution) object;
if (contribution.getPluginId() != null) {
IWorkbenchActivitySupport workbenchActivitySupport = PlatformUI.getWorkbench().getActivitySupport();
IIdentifier identifier = workbenchActivitySupport.getActivityManager().getIdentifier(
createUnifiedId(contribution));
return identifier.isEnabled();
}
}
if (object instanceof String) {
IWorkbenchActivitySupport workbenchActivitySupport = PlatformUI.getWorkbench().getActivitySupport();
IIdentifier identifier = workbenchActivitySupport.getActivityManager().getIdentifier((String) object);
return identifier.isEnabled();
}
return true;
}
private static final String createUnifiedId(IPluginContribution contribution) {
if (contribution.getPluginId() != null) {
return contribution.getPluginId() + '/' + contribution.getLocalId();
}
return contribution.getLocalId();
}
/**
* Opens <code>location</code> in a web-browser according to the Eclipse workbench preferences.
*
* @param location
* the url to open
* @see #openUrl(String, int)
*/
public static void openUrl(String location) {
openUrl(location, SWT.NONE);
}
/**
* Opens <code>location</code> in a web-browser according to the Eclipse workbench preferences.
*
* @param location
* the url to open
* @param customFlags
* additional flags that are passed to {@link IWorkbenchBrowserSupport}, pass
* {@link IWorkbenchBrowserSupport#AS_EXTERNAL} to force opening external browser
*/
public static void openUrl(String location, int customFlags) {
try {
URL url = null;
if (location != null) {
url = new URL(location);
}
if (WebBrowserPreference.getBrowserChoice() == WebBrowserPreference.EXTERNAL
|| (customFlags & IWorkbenchBrowserSupport.AS_EXTERNAL) != 0) {
try {
IWorkbenchBrowserSupport support = PlatformUI.getWorkbench().getBrowserSupport();
support.getExternalBrowser().openURL(url);
} catch (PartInitException e) {
Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN,
Messages.WorkbenchUtil_Browser_Initialization_Failed);
MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage());
}
} else {
IWebBrowser browser = null;
int flags = customFlags;
if (WorkbenchBrowserSupport.getInstance().isInternalWebBrowserAvailable()) {
flags |= IWorkbenchBrowserSupport.AS_EDITOR | IWorkbenchBrowserSupport.LOCATION_BAR
| IWorkbenchBrowserSupport.NAVIGATION_BAR;
} else {
flags |= IWorkbenchBrowserSupport.AS_EXTERNAL | IWorkbenchBrowserSupport.LOCATION_BAR
| IWorkbenchBrowserSupport.NAVIGATION_BAR;
}
String generatedId = "org.eclipse.mylyn.web.browser-" + Calendar.getInstance().getTimeInMillis(); //$NON-NLS-1$
browser = WorkbenchBrowserSupport.getInstance().createBrowser(flags, generatedId, null, null);
browser.openURL(url);
}
} catch (PartInitException e) {
Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN,
Messages.WorkbenchUtil_Browser_Initialization_Failed, e);
LogHelper.log(status);
MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage());
} catch (MalformedURLException e) {
if (location != null && location.trim().equals("")) { //$NON-NLS-1$
Status status = new Status(IStatus.WARNING, DiscoveryUi.ID_PLUGIN, Messages.WorkbenchUtil_No_URL_Error,
e);
MessageDialog.openWarning(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage());
} else {
Status status = new Status(IStatus.ERROR, DiscoveryUi.ID_PLUGIN, NLS.bind(
Messages.WorkbenchUtil_Invalid_URL_Error, location), e);
MessageDialog.openError(getShell(), Messages.WorkbenchUtil_Open_Location_Title, status.getMessage());
}
}
}
}
|
