blob: d923e4e0ec5d2e5210821283b9f8e85195c1a91b (
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
|
/*******************************************************************************
* Copyright (c) 2003, 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 - Initial API and implementation
*******************************************************************************/
package org.eclipse.ui.progress;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.ui.IWorkbenchPartSite;
/**
* IWorkbenchPartProgressService is an IProgressService that adds API for jobs
* that change the state in a IWorkbenchPartSite while they are being run.
* <p>
* This service can be acquired from your service locator (IWorkbenchPartSite):
* </p>
*
* <pre>
* <code>
* IWorkbenchSiteProgressService service = (IWorkbenchSiteProgressService) getSite().getService(IWorkbenchSiteProgressService.class);
* </code>
* </pre>
*
* <ul>
* <li>This service is not available globally, only at the part site level.</li>
* </ul>
* <p>
* WorkbenchParts may access an instance of IWorkbenchSiteProgressService by
* calling
* <code>getSite().getAdapter(IWorkbenchSiteProgressService.class);</code> ,
* although getSite().getService(IWorkbenchSiteProgressService.class) is
* preferred.
* </p>
*
* @see IWorkbenchPartSite#getAdapter(Class)
* @see org.eclipse.ui.services.IServiceLocator#getService(Class)
* @since 3.0
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IWorkbenchSiteProgressService extends IProgressService {
/**
* The property that is sent with busy notifications.
*
* @deprecated this property is no longer in use in the Eclipse SDK
*/
@Deprecated
String BUSY_PROPERTY = "SITE_BUSY"; //$NON-NLS-1$
/**
* Jobs scheduled with this method will cause the part's presentation to be
* changed to indicate that the part is busy and in a transient state until the
* job completes. Parts can also add customized busy indication by overriding
* <code>WorkbenchPart.showBusy()</code>. If useHalfBusyCursor is true then the
* cursor will change to the half busy cursor for the duration of the job.
*
* @param job The job to schedule
* @param delay The delay in scheduling.
* @param useHalfBusyCursor A boolean to indicate if the half busy cursor should
* be used while this job is running.
* @see Job#schedule(long)
*/
void schedule(Job job, long delay, boolean useHalfBusyCursor);
/**
* Jobs scheduled with this method will cause the part's presentation to be
* changed to indicate that the part is busy and in a transient state until the
* job completes. Parts can also add customized busy indication by overriding
* <code>WorkbenchPart.showBusy</code>.
*
* @param job The job to schedule
* @param delay The delay in scheduling.
* @see Job#schedule(long)
*/
void schedule(Job job, long delay);
/**
* Jobs scheduled with this method will cause the part's presentation to be
* changed to indicate that the part is busy and in a transient state until the
* job completes. Parts can also add customized busy indication by overriding
* <code>WorkbenchPart.showBusy</code>.
*
* @param job The job to schedule
* @see Job#schedule()
*/
void schedule(Job job);
/**
* Show busy state if any job of the specified family is running.
*
* @param family Object
* @see Job#belongsTo(Object)
*/
void showBusyForFamily(Object family);
/**
* Warn that the content of the part has changed. How this change is displayed
* to the end user is left up to the workbench renderer.
*/
void warnOfContentChange();
/**
* Increments the busy counter for this workbench site. This API should only be
* used for background work that does not use jobs. As long as there have been
* more calls to incrementBusy() than to decrementBusy(), the part will show a
* busy affordance. Each call to incrementBusy must be followed by a call to
* decrementBusy once the caller no longer needs the part to show the busy
* affordance.
* <p>
* Note that the job-related methods on this class are another way to let the
* part show a busy affordance. A part will only appear non-busy if no jobs have
* been scheduled through this service, and the internal busy counter is not
* positive.
* </p>
*
* @since 3.3
*/
void incrementBusy();
/**
* Decrements the busy counter for this workbench site. This API should only be
* used for background work that does not use jobs. It is an error to call this
* method without first making a matching call to {@link #incrementBusy()}.
*
* @since 3.3
*/
void decrementBusy();
}
|
