blob: 6eb9c5af75671721753ec81067e2ece284b08d25 (
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
|
/*******************************************************************************
* Copyright (c) 2018, 2019 Remain Software 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:
* wim.jongman@remainsoftware.com - initial API and implementation
*******************************************************************************/
package org.eclipse.tips.ide.internal;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.IJobChangeEvent;
import org.eclipse.core.runtime.jobs.JobChangeAdapter;
import org.eclipse.tips.core.ITipManager;
import org.eclipse.tips.core.internal.LogUtil;
import org.eclipse.ui.AbstractSourceProvider;
import org.eclipse.ui.ISources;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.progress.UIJob;
/**
* Internal class to source a new boolean variable in the IDE called "newtips".
*
*/
@SuppressWarnings("restriction")
public class TipSourceProvider extends AbstractSourceProvider {
private boolean fNewTips;
private ITipManager fManager;
private UIJob job;
private boolean startup = true;
public TipSourceProvider(ITipManager manager) {
fManager = manager;
}
@Override
public void dispose() {
}
@Override
public Map<?, ?> getCurrentState() {
Map<Object, Object> currentState = new HashMap<>();
currentState.put(Constants.SOURCE_UNREAD_TIPS, Boolean.valueOf(fNewTips));
return currentState;
}
@Override
public String[] getProvidedSourceNames() {
return new String[] { Constants.SOURCE_UNREAD_TIPS };
}
/**
* Propagate the new status of the <code>newtips</code> variable but always
* layouts all workbench windows to update the trim status.
*
* @param newTips true if there are new tips, false if there are no more new
* tips.
*/
public synchronized void setStatus(boolean newTips) {
boolean changed = fNewTips != newTips;
if (changed) {
fNewTips = newTips;
}
layoutWorkbench(changed);
}
private synchronized void layoutWorkbench(boolean changed) {
// prevent multiple jobs running and don't use Display if it is disposed during
// shutdown
if (job != null || PlatformUI.getWorkbench().getDisplay() == null
|| PlatformUI.getWorkbench().getDisplay().isDisposed()) {
return;
}
job = new UIJob(PlatformUI.getWorkbench().getDisplay(), Messages.TipSourceProvider_0) {
@Override
public IStatus runInUIThread(IProgressMonitor monitor) {
if (changed) {
fireSourceChanged(ISources.ACTIVE_WORKBENCH_WINDOW, getCurrentState());
}
// TODO remove this ugly hack to ensure the tips icon becomes visibile
// in the toolbar
// after the update of the toolitem
// The whole logic to layout can be removed once Bug 552737 is fixed
if (startup) {
// no need to layout the Shell during startup
startup = false;
return Status.OK_STATUS;
}
for (IWorkbenchWindow window : PlatformUI.getWorkbench().getWorkbenchWindows()) {
fManager.log(LogUtil.info(Messages.TipSourceProvider_1 + window + " -> " + fNewTips)); //$NON-NLS-1$
window.getShell().layout(true, true);
}
return Status.OK_STATUS;
}
};
job.addJobChangeListener(new JobChangeAdapter() {
@Override
public void done(IJobChangeEvent event) {
// ensure the job is recycled so that the next update triggers again a job
job = null;
}
});
job.schedule(5000); // allow the workbench to settle in.
}
}
|
